Konfigurowanie dostępu do interfejsu API

Dowiedz się, jak skonfigurować dostęp do interfejsu Data Manager API za pomocą pakietu SDK lub REST.

Wymagania wstępne

Zanim zaczniesz korzystać z interfejsu Data API, sprawdź, czy masz:

  1. Projekt Google Cloud.
  2. Konto Google, które spełnia oba te kryteria:
    1. ma przyznany dostęp do interfejsu Data Manager API po wypełnieniu formularza zainteresowania interfejsem Data Manager API. Jeśli widzisz stronę szczegółów produktu API, masz dostęp.
    2. ma uprawnienie serviceusage.services.enable w projekcie Google Cloud lub ma rolę, która obejmuje to uprawnienie; Na przykład zarówno roles/owner, jak i roles/serviceusage.serviceUsageAdmin zawierają uprawnienie serviceusage.services.enable. Aby sprawdzić uprawnienia, przeczytaj artykuł Wyświetlanie bieżącego dostępu.

Włącz API

Jeśli jeszcze tego nie zrobiono, włącz interfejs Data Manager API.

Jeśli nie możesz znaleźć interfejsu Data Manager API, sprawdź, czy Twoje konto Google spełnia wymagania wstępne.

Konfigurowanie uwierzytelniania

Wybierz i skonfiguruj metodę uwierzytelniania. Zalecamy skonfigurowanie domyślnego uwierzytelniania aplikacji, aby automatycznie znajdować dane logowania w środowisku. Ten interfejs API nie używa kluczy interfejsu API.

Zakres https://www.googleapis.com/auth/datamanager jest wymagany w przypadku wszystkich danych logowania używanych z interfejsem Data Manager API. Przykład użycia zakresów znajdziesz w dokumentacji polecenia gcloud auth application-default login.

Więcej informacji o uwierzytelnianiu i danych logowania aplikacji znajdziesz w artykułach Metody uwierzytelniania w GoogleJak działają domyślne dane logowania aplikacji.

Konfigurowanie dostępu do konta operacyjnego

Przyznaj adresowi e-mail powiązanemu z kontem użytkownika lub kontem usługi dostęp do Destination.

Konfigurowanie pakietu SDK dla wybranego języka programowania

Zainstaluj na komputerze lokalnym wybrany pakiet SDK:

REST

  1. Zastąp symbole zastępcze w tym przykładzie, np. OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_IDAUDIENCE_ID, wartościami odpowiednimi dla Twojego konta i miejsca docelowego.
  2. Zastąp PROJECT_ID identyfikatorem Google Cloud.
  3. Skopiuj przykład do wiersza poleceń, aby wysłać żądanie.

    Usuń atrybut linkedAccount z wpisu w destinations, jeśli nie uzyskujesz dostępu do operationAccount za pomocą ustalonego linku do produktu.

    #!/bin/bash
    
    # Uses gcloud to get an access token.
    DATA_MANAGER_ACCESS_TOKEN="$(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/datamanager)"
    
    # 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
    

Java

  1. Pobierz i rozpakuj plik google-cloud-ads-datamanager-v1-java.tar.gz.
  2. Przejdź do katalogu google-cloud-ads-datamanager-v1-java.
  3. Uruchom to polecenie, aby skompilować bibliotekę i opublikować ją w lokalnym repozytorium Maven do użycia z Mavenem lub Gradle.

    ./gradlew -Pversion=0.1.0 install
    
  4. W projekcie Java zadeklaruj zależność od biblioteki interfejsu 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. Opcjonalnie. Pobierz bibliotekę narzędzi i przykłady kodu.

    1. Pobierz i wyodrębnij plik data-manager-java.tar.gz.
    2. Przejdź do katalogu data-manager-java.
    3. W przypadku Maven lub Gradle uruchom to polecenie. To polecenie kompiluje i publikuje bibliotekę narzędziową w lokalnym repozytorium Maven.

      ./gradlew data-manager-util:install
      
    4. W projekcie Java zadeklaruj zależność od biblioteki narzędziowej.

      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. Aby sformatować i zaszyfrować dane, użyj narzędzi UserDataFormatterEncrypter w projekcie Java.

    6. Przeglądaj przykładowe fragmenty kodu w podkatalogu data-manager-samples. Aby uruchomić przykład z wiersza poleceń, użyj zadania Gradle run.

      Na przykład to polecenie uruchamia przykład IngestAudienceMembers i wyświetla instrukcję użycia:

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

      Aby ułatwić Ci rozpoczęcie pracy z przykładowymi danymi, użyj pliku dostępnego pod adresem data-manager-samples/src/main/resources/sampledata/audience_members_1.csv.

Python

  1. Pobierz plik ads-datamanager-v1-py.tar.gz.
  2. Przejdź do katalogu pobranych plików.
  3. Uruchom to polecenie, aby utworzyć bibliotekę i udostępnić ją innym projektom w tym samym środowisku Pythona:

    pip install ./ads-datamanager-v1-py.tar.gz
    
  4. W projekcie w języku Python zadeklaruj zależność od biblioteki interfejsu Data Manager API. Jeśli na przykład w projekcie używasz pliku requirements.txt, dodaj do niego ten wiersz:

    google-ads-data-manager=0.1.0
    
  5. Opcjonalnie. Pobierz bibliotekę narzędzi i przykłady kodu.

    1. Pobierz i wypakuj plik data-manager-python.tar.gz.
    2. Przejdź do katalogu data-manager-python.
    3. Aby zainstalować bibliotekę narzędziową w środowisku Pythona, uruchom to polecenie:

      pip install .
      
    4. W projekcie w Pythonie zadeklaruj zależność od biblioteki narzędzi. Jeśli na przykład w projekcie używasz pliku requirements.txt, dodaj do niego ten wiersz:

      google-ads-data-manager-util=0.1.0
      
    5. Aby sformatować i zaszyfrować dane, użyj narzędzi FormatterEncrypter w projekcie w Pythonie.

    6. Przeglądaj przykładowe fragmenty kodu w podkatalogu samples. Podaj argument --help podczas uruchamiania przykładu, aby wydrukować instrukcję użycia z oczekiwanymi parametrami.

      Aby ułatwić Ci rozpoczęcie pracy z przykładowymi danymi, użyj pliku dostępnego pod adresem samples/sampledata/audience_members_1.csv.

Node.js

  1. Pobierz i wyodrębnij plik ads-datamanager-v1-nodejs.tar.gz.
  2. Przejdź do katalogu ads-datamanager-v1-nodejs.
  3. Uruchom te polecenia, aby skompilować i spakować bibliotekę do pliku .tgz, który będzie można używać z npm.

    npm install
    npm pack
    

    Polecenia generują archiwum o nazwie google-cloud-datamanager-0.1.0.tgz.

  4. W projekcie Node.js zadeklaruj zależność od biblioteki Data Manager API, dodając wpis dependencies dla pełnej ścieżki i nazwy pliku google-cloud-datamanager-0.1.0.tgz.

PHP

  1. Pobierz i wypakuj plik google-cloud-ads-datamanager-v1-php.tar.gz.
  2. Przejdź do katalogu google-cloud-ads-datamanager-v1-php.
  3. Aby rozwiązać zależności biblioteki, uruchom to polecenie:

    composer update --prefer-dist
    
  4. W pliku composer.json projektu PHP na tym samym hoście zadeklaruj zależność od biblioteki Data Manager API, wykonując te czynności:

    1. Dodaj sekcję repositories, która wskazuje lokalizację katalogugoogle-cloud-ads-datamanager-v1-php.

      "repositories" : [
         {
            "type" : "path",
            "url" : "PATH_TO_CLIENT_LIBRARY"
         }
      ]
      
    2. Zadeklaruj zależność od biblioteki Data Manager API.

      "require": {
         "googleads/data-manager": "^0.1.0"
      }
      
  5. (Opcjonalnie) Pobierz bibliotekę narzędzi i przykłady kodu.

    1. Pobierz i wyodrębnij plik data-manager-php.tar.gz.
    2. Przejdź do katalogu data-manager-php.
    3. Aby rozwiązać zależności biblioteki, uruchom to polecenie:

      composer update --prefer-dist
      
    4. W pliku composer.json projektu PHP na tym samym hoście zadeklaruj zależność od biblioteki narzędziowej, wykonując te czynności:

      1. Dodaj wpis w sekcji repositories, który wskazuje lokalizację katalogu data-manager-php.

        "repositories" : [
           {
              "type" : "path",
              "url" : "PATH_TO_UTILITY_LIBRARY"
           }
        ]
        
      2. Zadeklaruj zależność od biblioteki narzędziowej.

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

      Aby sformatować dane, użyj narzędzia Formatter w projekcie PHP.

    5. Przeglądaj przykładowe fragmenty kodu w podkatalogu samples. Uruchom przykłady, wykonując te czynności:

      1. Przejdź do katalogu samples.

      2. Ustaw zmienną środowiskową DATA_MANAGER_PHP_LIB na ścieżkę, w której została wyodrębniona biblioteka klienta.

        export DATA_MANAGER_PHP_LIB="PATH_TO_CLIENT_LIBRARY"
        
      3. Aby rozwiązać zależności biblioteki, uruchom to polecenie:

        composer update --prefer-dist
        
      4. Uruchom przykłady, przekazując wymagane argumenty. Podczas uruchamiania przykładowego kodu przekaż argument --help, aby wydrukować instrukcję użycia z oczekiwanymi parametrami.

      Aby ułatwić Ci rozpoczęcie pracy z przykładowymi danymi, użyj pliku dostępnego pod adresem samples/sampledata/audience_members_1.csv.