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:
- Projekt Google Cloud.
- Konto Google, które ma uprawnienie
serviceusage.services.enablew projekcie Google Cloud lub ma rolę, która obejmuje to uprawnienie. Na przykład zarównoroles/owner, jak iroles/serviceusage.serviceUsageAdminzawierają uprawnienieserviceusage.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 APIJeś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:
Skonfiguruj ustawienia Google Auth Platform dla swojego projektu.
Otwórz stronę marki w konsoli Google Cloud.
Wybierz projekt.
Wypełnij formularz i kliknij Utwórz.
Ponieważ zakres interfejsu API Menedżera danych jest zakresem wrażliwym, wymagane jest wykonanie następujących kroków:
Otwórz ustawienia Dostęp do danych w projekcie.
Kliknij Dodaj lub usuń zakresy.
Na liście zakresów zaznacz pole wyboru obok pozycji Interfejs Data Manager API i kliknij Zaktualizuj.
Kliknij Zapisz.
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.
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 OAuth2W ostatnim kroku kliknij POBIERZ KONFIGURACJĘ KLIENTA i zanotuj wybraną lokalizację pobierania.
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"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 doDestination.
- Jeśli korzystasz z konta Google Ads lub konta partnera danych, postępuj zgodnie z instrukcjami, aby dodać adres e-mail użytkownika do konta.
- Jeśli korzystasz z konta Display & Video 360, postępuj zgodnie z instrukcjami, aby dodać adres e-mail użytkownika do konta.
Skonfiguruj zestaw SDK dla swojego języka programowania
Na swoim komputerze lokalnym zainstaluj wybrany przez siebie zestaw SDK:
REST
- 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.
- Zastąp PROJECT_ID identyfikatorem swojego Google Cloud.
Skopiuj przykład do wiersza poleceń, aby wysłać żądanie.
Usuń atrybut
linkedAccountwpisu wdestinations, jeśli nie uzyskujesz dostępu dooperatingAccountprzy 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.
Pobierz i rozpakuj data-manager-dotnet.tar.gz.
W projekcie .NET zadeklaruj
ProjectReferencezależność od biblioteki narzędzi. Zastąp PATH_TO_UTILITY_LIBRARY lokalizacją, w której wyodrębniłeś katalogdata-manager-dotnetzdata-manager-dotnet.tar.gz.<ProjectReference Include="PATH_TO_UTILITY_LIBRARY\Google.Ads.DataManager.Util\src\Google.Ads.DataManager.Util.csproj" />Aby sformatować dane, użyj narzędzia
Formatterw projekcie .NET.Przeglądaj przykładowe fragmenty kodu w podkatalogu
samples.Przejdź do katalogu
samplesi użyj poleceniadotnet run, aby uzyskać listę dostępnych próbek.dotnet runPodaj argument
--helppodczas uruchamiania próbki, aby wydrukować instrukcję użycia z oczekiwanymi parametrami.dotnet run -- ingest-audience-members --helpAby 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
- Pobierz i rozpakuj plik google-cloud-ads-datamanager-v1-java.tar.gz.
- Przejdź do katalogu
google-cloud-ads-datamanager-v1-java. Uruchom to polecenie, aby skompilować bibliotekę i opublikować ją w lokalnym repozytorium Maven do użycia z Mavenem lub Gradle.
./gradlew installW 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.
Sklonuj repozytorium GitHub.
git clone https://github.com/googleads/data-manager-java.gitPrzejdź do katalogu
data-manager-java.Zbuduj i opublikuj bibliotekę narzędzi w lokalnym repozytorium Maven.
./gradlew data-manager-util:installW 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>Aby sformatować i zaszyfrować dane, użyj narzędzi
UserDataFormatteriEncrypterw swoim projekcie Java.Przeglądaj przykłady kodu w podkatalogu
data-manager-sampleslub na GitHubie. Aby uruchomić przykład z wiersza poleceń, użyj zadania Gradlerun.Na przykład poniższe polecenie uruchamia przykład
IngestAudienceMembersi 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
- Pobierz i wyodrębnij plik ads-datamanager-v1-nodejs.tar.gz.
- Przejdź do katalogu
ads-datamanager-v1-nodejs. Uruchom następujące polecenie, aby skompilować i spakować bibliotekę klienta do pliku
.tgzdo użycia znpm.npm packPolecenie tworzy archiwum o nazwie
google-cloud-datamanager-0.1.4.tgz. Zanotuj lokalizację pliku, aby móc z niej skorzystać w kolejnych krokach.W projekcie Node.js zadeklaruj zależność od biblioteki klienta Data Manager API, dodając wpis
dependenciesdla pełnej ścieżki i nazwy plikugoogle-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.
- Pobierz i wypakuj plik data-manager-node.tar.gz.
- Przejdź do katalogu
data-manager-node. Przejdź do katalogu
util.cd utilUruchom to polecenie, aby skompilować i spakować bibliotekę narzędziową do pliku
.tgzdo użycia znpm.npm packPolecenie 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.W projekcie Node.js zadeklaruj zależność od biblioteki narzędziowej Data Manager API, dodając wpis
dependenciesdla pełnej ścieżki i nazwy plikugoogle-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
UserDataFormatterw projekcie Node.js.Przeglądaj przykładowe fragmenty kodu w podkatalogu
samples. Uruchom przykłady, wykonując te czynności:Skopiuj plik
google-cloud-datamanager-0.1.4.tgzdo katalogu nadrzędnego katalogudata-manager-node.Przejdź do katalogu
samplesw sekcjidata-manager-node.Uruchom następujące polecenie, aby skompilować przykłady.
npm run compileUruchom 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_membersi 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
- Pobierz i rozpakuj plik google-cloud-ads-datamanager-v1-php.tar.gz.
- Przejdź do katalogu
google-cloud-ads-datamanager-v1-php. Aby rozwiązać zależności biblioteki, uruchom to polecenie:
composer update --prefer-distW pliku
composer.jsonprojektu PHP na tym samym hoście zadeklaruj zależność od biblioteki API Menedżera Danych, wykonując następujące kroki:Dodaj sekcję
repositories, która wskazuje lokalizację katalogugoogle-cloud-ads-datamanager-v1-php."repositories" : [ { "type" : "path", "url" : "PATH_TO_CLIENT_LIBRARY" } ]Zadeklaruj zależność od biblioteki Data Manager API.
"require": { "googleads/data-manager": "0.1.4" }
Opcjonalnie: pobierz bibliotekę narzędzi i przykłady kodu.
- Pobierz i wyodrębnij plik data-manager-php.tar.gz.
- Przejdź do katalogu
data-manager-php. Aby rozwiązać zależności biblioteki, uruchom to polecenie:
composer update --prefer-distW pliku
composer.jsonprojektu PHP na tym samym hoście zadeklaruj zależność od biblioteki narzędziowej, wykonując następujące kroki:Dodaj wpis w sekcji
repositorieswskazujący lokalizację katalogudata-manager-php."repositories" : [ { "type" : "path", "url" : "PATH_TO_UTILITY_LIBRARY" } ]Zadeklaruj zależność od biblioteki narzędziowej.
"require": { "googleads/data-manager-util": "@dev" }
Aby sformatować dane, użyj narzędzia
Formatterw projekcie PHP.Przeglądaj przykładowe fragmenty kodu w podkatalogu
samples. Uruchom próbki, wykonując następujące kroki:Przejdź do katalogu
samples.Ustaw zmienną środowiskową
DATA_MANAGER_PHP_LIBna ścieżkę, w której została wyodrębniona biblioteka klienta.export DATA_MANAGER_PHP_LIB="PATH_TO_CLIENT_LIBRARY"Aby rozwiązać zależności biblioteki, uruchom to polecenie:
composer update --prefer-distUruchom 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.
- Pobierz i rozpakuj data-manager-python.tar.gz.
- Przejdź do katalogu
data-manager-python. Aby zainstalować bibliotekę narzędziową w środowisku Pythona, uruchom to polecenie:
pip install .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.0Aby sformatować i zaszyfrować dane, użyj narzędzi
FormatteriEncrypterw projekcie w języku Python.Przeglądaj przykłady kodu w podkatalogu
samples. Aby uruchomić przykłady, zainstaluj niezbędne zależności:pip install .[samples]Podaj argument
--helppodczas 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
- Dowiedz się więcej o przesyłaniu danych o odbiorcach.
- Dowiedz się więcej o wysyłaniu zdarzeń.
- Przeglądaj dokumentację referencyjną REST lub RPC.