Load PayPal data into BigQuery

Console

1. Go to the Data transfers page in the Google Cloud console.

   Go to Data transfers

2. Click add Create transfer.

3. In the Source type section, for Source, select PayPal.

4. In the Data source details section, do the following:

   • For Client Id, enter the PayPal client ID. For more information, see PayPal prerequisites.
   • For Client Secret, enter the PayPal client secret key. For more information, see PayPal prerequisites.
   • Select Is Sandbox if you are using a sandbox PayPal account.
   • For Start Date, enter a date in the format YYYY-MM-DD. The data transfer loads PayPal data starting from this date.
     • If this field is left blank, this transfer defaults to retrieving data from the past 3 years.
     • For information about what objects support the start date filter, see Supported objects.
   • For PayPal objects to transfer, enter the names of the PayPal objects to transfer, or click Browse and select the objects that you want to transfer.

5. In the Destination settings section, for Dataset, select the dataset that you created to store your data.

6. In the Transfer config name section, for Display name, enter a name for the data transfer.

7. In the Schedule options section, do the following:

   • In the Repeat frequency list, select an option to specify how often this data transfer runs. To specify a custom repeat frequency, select Custom. If you select On-demand, then this transfer runs when you manually trigger the transfer.
   • If applicable, select either Start now or Start at set time, and provide a start date and run time.

8. Optional: In the Notification options section, do the following:

   • To enable email notifications, toggle Email notification to the on position. When you enable this option, the transfer administrator receives an email notification when a transfer run fails.
   • To enable Pub/Sub transfer run notifications for this transfer, toggle Pub/Sub notifications to the on position. You can select your topic name, or you can click Create a topic to create one.

9. Click Save.

bq

Enter the bq mk command and supply the transfer creation flag --transfer_config:

bq mk
    --transfer_config
    --project_id=PROJECT_ID
    --data_source=DATA_SOURCE
    --display_name=DISPLAY_NAME
    --target_dataset=DATASET
    --params='PARAMETERS'

Where:

• PROJECT_ID (optional): your Google Cloud project ID. If --project_id isn't supplied to specify a particular project, the default project is used.
• DATA_SOURCE: the data source — paypal.
• DISPLAY_NAME: the display name for the data transfer configuration. The transfer name can be any value that lets you identify the transfer if you need to modify it later.
• DATASET: the target dataset for the transfer configuration.

• PARAMETERS: the parameters for the created transfer configuration in JSON format. For example: --params='{"param":"param_value"}'. The following are the parameters for a PayPal data transfer:

  • assets: a list of PayPal objects to be included in this transfer.
  • connector.authentication.clientId: client ID of the PayPal application.
  • connector.authentication.clientSecret: client secret of the PayPal application.
  • connector.isSandbox: set value to true if you are using a sandbox PayPal account, or false if you are using a production PayPal account.
  • connector.createdStartDate: (Optional) enter a date in the format YYYY-MM-DD. The data transfer loads PayPal data starting from this date.

For example, the following command creates a PayPal data transfer in the default project with all the required parameters:

  bq mk \
      --transfer_config \
      --target_dataset=mydataset \
      --data_source=PayPal \
      --display_name='My Transfer' \
      --params='{"assets":  ["Payments", "TransactionReports"],
          "connector.authentication.clientId": "112233445566",
          "connector.authentication.clientSecret":"123456789",
          "connector.isSandbox":"false",
          "connector.createdStartDate":  "2025-01-01"}'

When you create a data transfer using the bq command-line tool, the transfer configuration schedules data transfers once every 8 hours.

API

Use the projects.locations.transferConfigs.create method and supply an instance of the TransferConfig resource.