Konfigurowanie dostępu do interfejsu API

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

Wymagania wstępne

Zanim zaczniesz korzystać z interfejsu API danych, upewnij się, że masz następujące elementy:

  1. Projekt Google Cloud.
  2. Konto Google, które 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 nie masz jeszcze włączonego interfejsu Data Manager API, kliknij Włącz interfejs Data Manager API lub wykonaj instrukcje, aby ręcznie wykonać ten krok.

Włączanie interfejsu Data Manager API

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

Konfigurowanie uwierzytelniania

Oprócz kluczy API możesz użyć dowolnej metody uwierzytelniania Google. Zalecamy zapoznanie się ze sposobem wyboru właściwej metody uwierzytelniania dla danego przypadku użycia, aby zdecydować, które podejście jest odpowiednie w danym przypadku.

Dwiema popularnymi metodami uwierzytelniania są konta użytkowników i konta usługowe:

  • Konta użytkowników: reprezentują osoby, które bezpośrednio korzystają z interfejsów API i usług Google.
  • Konta usługi: reprezentują aplikacje, a nie osoby, jako użytkowników. Umożliwiają aplikacjom zarządzanie uwierzytelnianiem i autoryzacją. Na przykład, gdy aplikacja musi uzyskać dostęp do zasobów Google Cloud.

Twoja integracja może używać domyślnych poświadczeń aplikacji (ADC) do automatycznego wyszukiwania poświadczeń w środowisku, dzięki czemu nie musisz zmieniać kodu klienta w celu uwierzytelnienia.

Wybierz opcję Konto użytkownika lub Imitacja konta usługi, aby skonfigurować ADC:

Oto kroki uwierzytelniania za pomocą danych logowania użytkownika:

  1. Skonfiguruj ustawienia Google Auth Platform dla swojego projektu.

    1. Otwórz stronę marki w konsoli Google Cloud.

    2. Wybierz projekt.

    3. Wypełnij formularz i kliknij Utwórz.

  2. Ponieważ zakres interfejsu API Menedżera danych jest zakresem wrażliwym, wymagane jest wykonanie następujących kroków:

    1. Otwórz ustawienia Dostęp do danych w projekcie.

    2. Kliknij Dodaj lub usuń zakresy.

    3. Na liście zakresów zaznacz pole wyboru obok pozycji Interfejs Data Manager API i kliknij Zaktualizuj.

    4. Kliknij Zapisz.

    5. Przejdź do sekcji Odbiorcy w Konsoli Google Cloud i zaktualizuj Stan publikacji oraz Typ użytkownika. Więcej informacji o tych ustawieniach znajdziesz w artykule Zarządzaj odbiorcami aplikacji.

  3. Kliknij Utwórz klienta OAuth2, aby utworzyć klienta OAuth2 w projekcie, lub postępuj zgodnie z instrukcjami, aby utworzyć klienta OAuth2 na komputerze stacjonarnym.

    Utwórz klienta OAuth2

    W ostatnim kroku kliknij POBIERZ KONFIGURACJĘ KLIENTA i zanotuj wybraną lokalizację pobierania.

  4. Wygeneruj lokalny plik ADC, uruchamiając następujące polecenie. To polecenie uruchamia przepływ sieciowy, w którym zostaniesz poproszony o zalogowanie się na konto Google używane z interfejsem API.

    Zastąp PATH_TO_CLIENT_JSON nazwą pobranego pliku JSON.

    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. Sprawdź, czy dane uwierzytelniające są skonfigurowane prawidłowo, korzystając z poniższego polecenia. Jeśli polecenie zadziała, w konsoli zostanie wydrukowany token dostępu.

    gcloud auth application-default print-access-token
    

Aby dowiedzieć się więcej o uwierzytelnianiu i poświadczeniach dla swojej aplikacji, zapoznaj się z tematami Metody uwierzytelniania w Google i Jak działają domyślne poświadczenia aplikacji.

Konfigurowanie dostępu do konta operacyjnego

Przyznaj adresowi e-mail powiązanemu z Twoim kontem użytkownika dostęp do Destination.

Skonfiguruj zestaw SDK dla swojego języka programowania

Na swoim komputerze lokalnym zainstaluj wybrany przez siebie zestaw SDK:

REST

  1. Zaktualizuj symbole zastępcze w poniższym przykładzie, takie jak OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_ID i AUDIENCE_ID, podając wartości dla swojego konta i miejsca docelowego.
  2. Zastąp PROJECT_ID identyfikatorem swojego Google Cloud.
  3. Skopiuj przykład do wiersza poleceń, aby wysłać żądanie.

    Usuń atrybut linkedAccount wpisu w destinations, jeśli nie uzyskujesz dostępu do operatingAccount przy użyciu ustalonego łącza do produktu.

    #!/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": {
            "accountType": "OPERATING_ACCOUNT_TYPE",
            "accountId": "OPERATING_ACCOUNT_ID"
          },
          "loginAccount": {
            "accountType": "LOGIN_ACCOUNT_TYPE",
            "accountId": "LOGIN_ACCOUNT_ID"
          },
          "linkedAccount": {
            "accountType": "LINKED_ACCOUNT_TYPE",
            "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

Instalowanie biblioteki klienta

Aby dodać zależność do biblioteki klienta w projekcie, postępuj zgodnie z instrukcjami zawartymi w przewodniku instalacji biblioteki klienta.NET.

Opcjonalnie: Pobierz bibliotekę narzędzi i przykłady kodu.

  1. Pobierz i rozpakuj data-manager-dotnet.tar.gz.

  2. W projekcie .NET zadeklaruj ProjectReference zależność od biblioteki narzędzi. Zastąp PATH_TO_UTILITY_LIBRARY lokalizacją, w której wyodrębniłeś katalog data-manager-dotnet z data-manager-dotnet.tar.gz.

    <ProjectReference Include="PATH_TO_UTILITY_LIBRARY\Google.Ads.DataManager.Util\src\Google.Ads.DataManager.Util.csproj" />
    
  3. Aby sformatować dane, użyj narzędzia Formatter w projekcie .NET.

  4. Przeglądaj przykładowe fragmenty kodu w podkatalogu samples.

    Przejdź do katalogu samples i użyj polecenia dotnet run, aby uzyskać listę dostępnych próbek.

    dotnet run
    

    Podaj argument --help podczas uruchamiania próbki, aby wydrukować instrukcję użycia z oczekiwanymi parametrami.

    dotnet run -- ingest-audience-members --help
    

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

Java

Instalowanie biblioteki klienta

  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 install
    
  4. W projekcie Java zadeklaruj zależność od biblioteki API Data Manager.

    Gradle:

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

    Maven:

    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>gapic-google-cloud-ads-datamanager-v1-java</artifactId>
      <version>0.1.4</version>
    </dependency>
    

Opcjonalnie: pobierz bibliotekę narzędzi i przykłady kodu.

  1. Sklonuj repozytorium GitHub.

    git clone https://github.com/googleads/data-manager-java.git
    
  2. Przejdź do katalogu data-manager-java.

  3. Zbuduj i opublikuj bibliotekę narzędzi 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 UserDataFormatter i Encrypter w swoim projekcie Java.

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

    Na przykład poniższe polecenie uruchamia przykład IngestAudienceMembers i drukuje 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.

Node.js

Instalowanie biblioteki klienta

  1. Pobierz i wyodrębnij plik ads-datamanager-v1-nodejs.tar.gz.
  2. Przejdź do katalogu ads-datamanager-v1-nodejs.
  3. Uruchom następujące polecenie, aby skompilować i spakować bibliotekę klienta do pliku .tgz do użycia z npm.

    npm pack
    

    Polecenie tworzy archiwum o nazwie google-cloud-datamanager-0.1.4.tgz. Zanotuj lokalizację pliku, aby móc z niej skorzystać w kolejnych krokach.

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

    {
       "dependencies": {
          ...
          "@google-cloud/datamanager": "file:PATH_TO_CLIENT_LIBRARY/google-cloud-datamanager-0.1.4.tgz",
          ...
       }
    }
    

Opcjonalnie: Pobierz bibliotekę narzędzi i przykłady kodu.

  1. Pobierz i wypakuj plik data-manager-node.tar.gz.
  2. Przejdź do katalogu data-manager-node.
  3. Przejdź do katalogu util.

    cd util
    
  4. Uruchom to polecenie, aby skompilować i spakować bibliotekę narzędziową do pliku .tgz do użycia z npm.

    npm pack
    

    Polecenie generuje archiwum o nazwie google-ads-datamanager-util-0.1.0.tgz. Zapisz lokalizację pliku, aby móc go użyć w następnych krokach.

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

    {
       "dependencies": {
          ...
          "@google-ads/data-manager-util": "file:PATH_TO_UTILITY_LIBRARY/google-ads-datamanager-util-0.1.0.tgz",
          ...
       }
    }
    

    Aby sformatować dane, użyj narzędzia UserDataFormatter w projekcie Node.js.

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

    1. Skopiuj plik google-cloud-datamanager-0.1.4.tgz do katalogu nadrzędnego katalogu data-manager-node.

    2. Przejdź do katalogu samples w sekcji data-manager-node.

    3. Uruchom następujące polecenie, aby skompilować przykłady.

      npm run compile
      
    4. Uruchom przykłady, przekazując wymagane argumenty. Podczas uruchamiania przykładu przekaż argument --help, aby wydrukować instrukcję użycia z oczekiwanymi parametrami.

      Na przykład poniższe polecenie uruchamia przykład ingest_audience_members i drukuje instrukcję użycia:

      npx ts-node audiences/ingest_audience_members.ts --help
      

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

PHP

Instalowanie biblioteki klienta

  1. Pobierz i rozpakuj 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 API Menedżera Danych, wykonując następujące kroki:

    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.4"
      }
      

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 następujące kroki:

    1. Dodaj wpis w sekcji repositories wskazujący 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 próbki, wykonując następujące kroki:

    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 próbki, przekazując wszystkie wymagane argumenty. Podczas uruchamiania przykładu przekaż argument --help, aby wydrukować instrukcję użycia z oczekiwanymi parametrami.

    Aby zacząć pracę z przykładowymi danymi, skorzystaj z pliku dostępnego pod adresem samples/sampledata/audience_members_1.csv.

Python

Instalowanie biblioteki klienta

Postępuj zgodnie z instrukcjami zawartymi w przewodniku instalacji biblioteki klienta Pythona, aby dodać zależność do biblioteki klienta google-ads-datamanager w swoim projekcie.

Opcjonalnie: Pobierz bibliotekę narzędzi i przykłady kodu.

  1. Pobierz i rozpakuj 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.2.0
    
  5. Aby sformatować i zaszyfrować dane, użyj narzędzi FormatterEncrypter w projekcie w języku Python.

  6. Przeglądaj przykłady kodu w podkatalogu samples. Aby uruchomić przykłady, zainstaluj niezbędne zależności:

    pip install .[samples]
    

    Podaj argument --help podczas uruchamiania próbki, 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.

Ruby

Instalowanie biblioteki klienta

Aby dodać zależność do biblioteki klienta w swoim projekcie, postępuj zgodnie z instrukcjami zawartymi w przewodniku instalacji biblioteki klienta Ruby.

Dalsze kroki