Menyiapkan akses API

Berikut cara menyiapkan akses ke Data Manager API dengan SDK atau REST.

Prasyarat

Sebelum dapat menggunakan Data API, pastikan Anda memiliki hal berikut:

  1. Project Google Cloud.
  2. Akun Google yang memenuhi kedua kriteria berikut:
    1. Telah diberi akses ke Data Manager API, setelah Anda mengisi Formulir Minat Data Manager API. Jika Anda dapat melihat halaman detail produk API, Anda memiliki akses.
    2. Memiliki izin serviceusage.services.enable di project Google Cloud Anda, atau memiliki peran yang mencakup izin tersebut. Misalnya, roles/owner dan roles/serviceusage.serviceUsageAdmin keduanya mencakup izin serviceusage.services.enable. Untuk memeriksa izin Anda, lihat Melihat akses saat ini.

Mengaktifkan API

Jika belum melakukannya, aktifkan Data Manager API dengan mengklik Aktifkan Data Manager API atau ikuti petunjuk untuk melakukan langkah ini secara manual.

Aktifkan Data Manager API

Jika Anda tidak dapat menemukan Data Manager API atau Enable the Data Manager API gagal, pastikan Akun Google Anda memenuhi prasyarat.

Menyiapkan autentikasi

Anda dapat menggunakan salah satu Metode autentikasi di Google selain kunci API. Sebaiknya tinjau cara Memilih metode autentikasi yang tepat untuk kasus penggunaan Anda untuk memutuskan pendekatan mana yang sesuai untuk kasus penggunaan Anda.

Dua metode autentikasi umum adalah akun pengguna dan akun layanan:

  • Akun pengguna: Mewakili orang yang berinteraksi langsung dengan Google API dan layanan Google.
  • Akun layanan: Mewakili aplikasi, bukan orang, sebagai pengguna. API ini memungkinkan aplikasi Anda mengelola autentikasi dan otorisasi. Misalnya, jika aplikasi perlu mengakses resource Google Cloud.

Integrasi Anda dapat menggunakan Kredensial Default Aplikasi (ADC) untuk menemukan kredensial secara otomatis dari lingkungan sehingga Anda tidak perlu mengubah kode klien untuk mengautentikasi.

Pilih Akun pengguna atau Peniruan identitas akun layanan untuk menyiapkan ADC:

Berikut adalah langkah-langkah untuk mengautentikasi dengan kredensial akun pengguna:

  1. Konfigurasi setelan Google Auth Platform untuk project Anda.

    1. Buka halaman Branding di Konsol Google Cloud.

    2. Pilih project Anda.

    3. Isi formulir, lalu klik Buat.

  2. Karena cakupan Data Manager API adalah cakupan sensitif, langkah-langkah berikut diperlukan:

    1. Buka setelan Akses Data untuk project Anda.

    2. Klik Tambahkan atau hapus cakupan.

    3. Centang kotak di samping Data Manager API dalam daftar cakupan, lalu klik Perbarui.

    4. Klik Simpan.

    5. Buka Audience di Konsol Google Cloud, lalu perbarui Publishing status dan User type. Pelajari lebih lanjut setelan ini di Mengelola Audiens Aplikasi.

  3. Klik Buat klien OAuth2 untuk membuat klien OAuth2 di project, atau ikuti petunjuk untuk membuat klien OAuth2 Desktop.

    Buat klien OAuth2

    Pada langkah terakhir, klik DOWNLOAD KONFIGURASI KLIEN dan catat lokasi download yang Anda pilih.

  4. Buat file ADC lokal dengan menjalankan perintah berikut. Perintah ini meluncurkan alur web tempat Anda diminta untuk login ke Akun Google yang Anda gunakan dengan API.

    Ganti PATH_TO_CLIENT_JSON dengan nama file JSON yang Anda download.

    gcloud auth application-default login \
      --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform" \
      --client-id-file="PATH_TO_CLIENT_JSON"
    
  5. Pastikan kredensial disiapkan dengan benar menggunakan perintah berikut. Jika berhasil, perintah akan mencetak token akses ke konsol.

    gcloud auth application-default print-access-token
    

Untuk mempelajari lebih lanjut autentikasi dan kredensial untuk aplikasi Anda, lihat Metode autentikasi di Google dan Cara kerja Kredensial Default Aplikasi.

Menyiapkan akses akun operasi

Memberi akses ke email yang terkait dengan akun pengguna Anda ke Destination.

  • Jika menggunakan akun partner data atau Google Ads, ikuti petunjuknya untuk menambahkan email pengguna ke akun tersebut.
  • Jika menggunakan akun Display & Video 360, ikuti petunjuk untuk menambahkan email pengguna ke akun.

Menyiapkan SDK untuk bahasa pemrograman Anda

Di komputer lokal Anda, instal SDK pilihan Anda:

REST

  1. Perbarui placeholder dalam contoh berikut, seperti OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_ID, dan AUDIENCE_ID, dengan nilai untuk akun dan tujuan Anda.
  2. Ganti PROJECT_ID dengan ID Google Cloud Anda.
  3. Salin contoh ke command line untuk mengirim permintaan.

    Hapus atribut linkedAccount entri di destinations jika Anda tidak mengakses operatingAccount menggunakan link produk yang sudah dibuat.

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account, the command that specifies
    # --scopes fails. This sample falls back to the command without the
    # --scopes argument.
    DATA_MANAGER_ACCESS_TOKEN="$(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/datamanager || \
      gcloud auth application-default print-access-token)"
    
    # Fetches and prints the scope information for the access token. If you
    # get scope-related errors when you send the request in the next step,
    # verify that this output includes the Data Manager API scope:
    #   https://www.googleapis.com/auth/datamanager
    curl https://www.googleapis.com/oauth2/v1/tokeninfo?access_token="${DATA_MANAGER_ACCESS_TOKEN}"
    
    # Sends the request.
    curl -X POST "https://datamanager.googleapis.com/v1/audienceMembers:ingest" \
      --header "Authorization: Bearer ${DATA_MANAGER_ACCESS_TOKEN}" \
      --header "x-goog-user-project: PROJECT_ID" \
      --header "Content-Type: application/json" \
      --data @- <<EOF
    {
      "destinations": [
        {
          "operatingAccount": {
            "product": "OPERATING_ACCOUNT_PRODUCT",
            "accountId": "OPERATING_ACCOUNT_ID"
          },
          "loginAccount": {
            "product": "LOGIN_ACCOUNT_PRODUCT",
            "accountId": "LOGIN_ACCOUNT_ID"
          },
          "linkedAccount": {
            "product": "LINKED_ACCOUNT_PRODUCT",
            "accountId": "LINKED_ACCOUNT_ID"
          },
          "productDestinationId": "AUDIENCE_ID"
        }
      ],
      "audienceMembers": [
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
              },
              {
                "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
              },
              {
                "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
              },
              {
                "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
              },
              {
                "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
              },
              {
                "emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
              }
            ]
          }
        }
      ],
      "consent": {
        "adUserData": "CONSENT_GRANTED",
        "adPersonalization": "CONSENT_GRANTED"
      },
      "encoding": "HEX",
      "termsOfService": {
        "customerMatchTermsOfServiceStatus": "ACCEPTED"
      },
      "validateOnly": true
    }
    EOF
    

.NET

  1. Download dan ekstrak google-cloud-ads-datamanager-v1-csharp.tar.gz.

  2. Di project .NET Anda, deklarasikan dependensi ProjectReference pada library Data Manager API. Ganti PATH_TO_CLIENT_LIBRARY dengan lokasi tempat Anda mengekstrak direktori google-cloud-ads-datamanager-v1-csharp dari google-cloud-ads-datamanager-v1-csharp.tar.gz.

    <ProjectReference Include="PATH_TO_CLIENT_LIBRARY\Google.Ads.DataManager.V1\Google.Ads.DataManager.V1.csproj" />
    
  3. Opsional. Dapatkan library utilitas dan contoh kode.

    1. Download dan ekstrak data-manager-dotnet.tar.gz.

    2. Dalam project .NET, deklarasikan dependensi ProjectReference pada library utilitas. Ganti PATH_TO_UTILITY_LIBRARY dengan lokasi tempat Anda mengekstrak direktori data-manager-dotnet dari data-manager-dotnet.tar.gz.

      <ProjectReference Include="PATH_TO_UTILITY_LIBRARY\Google.Ads.DataManager.Util\src\Google.Ads.DataManager.Util.csproj" />
      
    3. Untuk memformat data, gunakan utilitas Formatter di project .NET Anda.

    4. Jelajahi contoh kode di subdirektori samples.

      Untuk menjalankan contoh kode, tetapkan variabel lingkungan DATA_MANAGER_DOTNET_LIB ke lokasi tempat Anda mengekstrak direktori google-cloud-ads-datamanager-v1-csharp dari google-cloud-ads-datamanager-v1-csharp.tar.gz.

      export DATA_MANAGER_DOTNET_LIB="PATH_TO_CLIENT_LIBRARY"
      

      Ubah ke direktori samples dan gunakan dotnet run untuk mendapatkan daftar sampel yang tersedia.

      dotnet run --framework net8.0
      

      Teruskan argumen --help saat menjalankan contoh untuk mencetak pernyataan penggunaan dengan parameter yang diharapkan.

      dotnet run --framework net8.0 -- ingest-audience-members --help
      

      Untuk membantu Anda memulai dengan beberapa data sampel, gunakan file di samples/sampledata/audience_members_1.csv.

Java

  1. Download dan ekstrak google-cloud-ads-datamanager-v1-java.tar.gz.
  2. Arahkan ke direktori google-cloud-ads-datamanager-v1-java.
  3. Jalankan perintah berikut untuk membangun dan memublikasikan library ke repositori Maven lokal Anda untuk digunakan dengan Maven atau Gradle.

    ./gradlew -Pversion=0.1.0 install
    
  4. Dalam project Java Anda, deklarasikan dependensi pada library Data Manager API.

    Gradle:

    implementation 'com.google.cloud:gapic-google-cloud-ads-datamanager-v1-java:0.1.0'
    

    Maven:

    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>gapic-google-cloud-ads-datamanager-v1-java</artifactId>
      <version>0.1.0</version>
    </dependency>
    
  5. Opsional. Dapatkan library utilitas dan contoh kode.

    1. Buat clone repositori GitHub.

      git clone https://github.com/googleads/data-manager-java.git
      
    2. Arahkan ke direktori data-manager-java.

    3. Bangun dan publikasikan library utilitas ke repositori Maven lokal Anda.

      ./gradlew data-manager-util:install
      
    4. Dalam project Java Anda, deklarasikan dependensi pada library utilitas.

      Gradle:

      implementation 'com.google.api-ads:data-manager-util:0.1.0'
      

      Maven:

      <dependency>
         <groupId>com.google.api-ads</groupId>
         <artifactId>data-manager-util</artifactId>
         <version>0.1.0</version>
      </dependency>
      
    5. Untuk memformat dan mengenkripsi data, gunakan utilitas UserDataFormatter dan Encrypter di project Java Anda.

    6. Jelajahi contoh kode di subdirektori data-manager-samples atau di GitHub. Untuk menjalankan sampel dari command line, gunakan tugas Gradle run.

      Misalnya, perintah berikut menjalankan sampel IngestAudienceMembers dan mencetak pernyataan penggunaan:

      ./gradlew data-manager-samples:run \
        --args='IngestAudienceMembers --help'
      

      Untuk membantu Anda memulai dengan beberapa data sampel, gunakan file di data-manager-samples/src/main/resources/sampledata/audience_members_1.csv.

Python

  1. Download ads-datamanager-v1-py.tar.gz.
  2. Buka direktori download.
  3. Jalankan perintah berikut untuk membangun library dan menyediakannya untuk project lain di lingkungan Python yang sama:

    pip install ./ads-datamanager-v1-py.tar.gz
    
  4. Dalam project Python Anda, deklarasikan dependensi pada library Data Manager API. Misalnya, jika menggunakan file requirements.txt dalam project Anda, tambahkan baris berikut ke file:

    google-ads-data-manager=0.1.0
    
  5. Opsional. Dapatkan library utilitas dan contoh kode.

    1. Download dan ekstrak data-manager-python.tar.gz.
    2. Arahkan ke direktori data-manager-python.
    3. Untuk menginstal library utilitas di lingkungan Python, jalankan perintah berikut:

      pip install .
      
    4. Di project Python Anda, deklarasikan dependensi pada library utilitas. Misalnya, jika menggunakan file requirements.txt dalam project Anda, tambahkan baris berikut ke file:

      google-ads-data-manager-util=0.1.0
      
    5. Untuk memformat dan mengenkripsi data, gunakan utilitas Formatter dan Encrypter di project Python Anda.

    6. Jelajahi contoh kode di subdirektori samples. Teruskan argumen --help saat menjalankan contoh untuk mencetak pernyataan penggunaan dengan parameter yang diharapkan.

      Untuk membantu Anda memulai dengan beberapa data sampel, gunakan file di samples/sampledata/audience_members_1.csv.

Node.js

  1. Download dan ekstrak ads-datamanager-v1-nodejs.tar.gz.
  2. Arahkan ke direktori ads-datamanager-v1-nodejs.
  3. Jalankan perintah berikut untuk mengompilasi dan mengemas library ke dalam file .tgz untuk digunakan dengan npm.

    npm install
    npm pack
    

    Perintah ini akan membuat arsip bernama google-cloud-datamanager-0.1.0.tgz.

  4. Di project Node.js Anda, deklarasikan dependensi pada library Data Manager API dengan menambahkan entri dependencies untuk jalur lengkap dan nama file google-cloud-datamanager-0.1.0.tgz.

PHP

  1. Download dan ekstrak google-cloud-ads-datamanager-v1-php.tar.gz.
  2. Arahkan ke direktori google-cloud-ads-datamanager-v1-php.
  3. Jalankan perintah berikut untuk menyelesaikan dependensi library:

    composer update --prefer-dist
    
  4. Dalam file composer.json project PHP Anda di host yang sama, deklarasikan dependensi pada library Data Manager API menggunakan langkah-langkah berikut:

    1. Tambahkan bagian repositories yang mengarah ke lokasi direktori google-cloud-ads-datamanager-v1-php.

      "repositories" : [
         {
            "type" : "path",
            "url" : "PATH_TO_CLIENT_LIBRARY"
         }
      ]
      
    2. Deklarasikan dependensi pada library Data Manager API.

      "require": {
         "googleads/data-manager": "^0.1.0"
      }
      
  5. (Opsional) Dapatkan library utilitas dan contoh kode.

    1. Download dan ekstrak data-manager-php.tar.gz.
    2. Arahkan ke direktori data-manager-php.
    3. Jalankan perintah berikut untuk menyelesaikan dependensi library:

      composer update --prefer-dist
      
    4. Dalam file composer.json project PHP Anda di host yang sama, deklarasikan dependensi pada library utilitas menggunakan langkah-langkah berikut:

      1. Tambahkan entri di bagian repositories yang mengarah ke lokasi direktori data-manager-php.

        "repositories" : [
           {
              "type" : "path",
              "url" : "PATH_TO_UTILITY_LIBRARY"
           }
        ]
        
      2. Deklarasikan dependensi pada library utilitas.

        "require": {
           "googleads/data-manager-util": "@dev"
        }
        

      Untuk memformat data, gunakan utilitas Formatter di project PHP Anda.

    5. Jelajahi contoh kode di subdirektori samples. Jalankan contoh menggunakan langkah-langkah berikut:

      1. Arahkan ke direktori samples.

      2. Tetapkan variabel lingkungan DATA_MANAGER_PHP_LIB ke jalur tempat Anda mengekstrak library klien.

        export DATA_MANAGER_PHP_LIB="PATH_TO_CLIENT_LIBRARY"
        
      3. Jalankan perintah berikut untuk menyelesaikan dependensi library:

        composer update --prefer-dist
        
      4. Jalankan contoh, dengan meneruskan argumen yang diperlukan. Teruskan argumen --help saat menjalankan sampel untuk mencetak pernyataan penggunaan dengan parameter yang diharapkan.

      Untuk membantu Anda memulai dengan beberapa data sampel, gunakan file di samples/sampledata/audience_members_1.csv.

Langkah berikutnya