API-Zugriff einrichten

So richten Sie den Zugriff auf die Data Manager API mit einem SDK oder REST ein:

Vorbereitung

Bevor Sie die Data API verwenden können, benötigen Sie Folgendes:

  1. Ein Google Cloud-Projekt.
  2. Ein Google-Konto, das beide der folgenden Kriterien erfüllt:
    1. Sie haben Zugriff auf die Data Manager API erhalten, nachdem Sie das Interessenbekundungsformular für die Data Manager API ausgefüllt haben. Wenn Sie die Seite API-Produktdetails sehen, haben Sie Zugriff.
    2. Hat die Berechtigung serviceusage.services.enable für Ihr Google Cloud-Projekt oder eine Rolle, die diese Berechtigung enthält. Beispiel: Sowohl roles/owner als auch roles/serviceusage.serviceUsageAdmin enthalten die Berechtigung serviceusage.services.enable. Informationen zum Prüfen Ihrer Berechtigungen finden Sie unter Aktuellen Zugriff ansehen.

API aktivieren

Falls noch nicht geschehen, aktivieren Sie die Data Manager API.

Wenn Sie die Data Manager API nicht finden, prüfen Sie, ob Ihr Google-Konto die Voraussetzungen erfüllt.

Authentifizierung einrichten

Wählen Sie eine Authentifizierungsmethode aus und richten Sie sie ein. Wir empfehlen, Standardanmeldedaten für Anwendungen einzurichten, damit Anmeldedaten automatisch aus der Umgebung abgerufen werden. Für diese API werden keine API-Schlüssel verwendet.

Der Bereich https://www.googleapis.com/auth/datamanager ist für alle Anmeldedaten erforderlich, die mit der Data Manager API verwendet werden. Ein Beispiel für die Verwendung von Bereichen finden Sie in der Dokumentation zum Befehl gcloud auth application-default login.

Weitere Informationen zur Authentifizierung und zu Anmeldedaten für Ihre App finden Sie unter Authentifizierungsmethoden bei Google und Funktionsweise von Standardanmeldedaten für Anwendungen.

Zugriff auf das Betriebskonto einrichten

Erteilen Sie der E-Mail-Adresse, die mit Ihrem Nutzer- oder Dienstkonto verknüpft ist, Zugriff auf Destination.

SDK für Ihre Programmiersprache einrichten

Installieren Sie auf Ihrem lokalen Computer das SDK Ihrer Wahl:

REST

  1. Ersetzen Sie die Platzhalter im folgenden Beispiel, z. B. OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_ID und AUDIENCE_ID, durch die Werte für Ihr Konto und Ziel.
  2. Ersetzen Sie PROJECT_ID durch die ID Ihres Google Cloud-Projekts.
  3. Kopieren Sie das Beispiel in die Befehlszeile, um die Anfrage zu senden.

    Entfernen Sie das Attribut linkedAccount des Eintrags in der destinations, wenn Sie nicht über einen vorhandenen Produktlink auf die operationAccount zugreifen.

    #!/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. Laden Sie google-cloud-ads-datamanager-v1-java.tar.gz herunter und entpacken Sie die Datei.
  2. Rufen Sie das Verzeichnis google-cloud-ads-datamanager-v1-java auf.
  3. Führen Sie den folgenden Befehl aus, um die Bibliothek zu erstellen und in Ihrem lokalen Maven-Repository zur Verwendung mit Maven oder Gradle zu veröffentlichen.

    ./gradlew -Pversion=0.1.0 install
    
  4. Geben Sie in Ihrem Java-Projekt eine Abhängigkeit von der Data Manager API-Bibliothek an.

    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. Optional: Dienstprogrammbibliothek und Codebeispiele abrufen

    1. Laden Sie data-manager-java.tar.gz herunter und entpacken Sie die Datei.
    2. Rufen Sie das Verzeichnis data-manager-java auf.
    3. Führen Sie für Maven oder Gradle den folgenden Befehl aus. Mit diesem Befehl wird die Hilfsbibliothek erstellt und in Ihrem lokalen Maven-Repository veröffentlicht.

      ./gradlew data-manager-util:install
      
    4. Deklarieren Sie in Ihrem Java-Projekt eine Abhängigkeit von der Utility-Bibliothek.

      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. Verwenden Sie die Dienstprogramme UserDataFormatter und Encrypter in Ihrem Java-Projekt, um die Daten zu formatieren und zu verschlüsseln.

    6. Sehen Sie sich die Codebeispiele im Unterverzeichnis data-manager-samples an. Verwenden Sie den Gradle-Task run, um ein Beispiel über die Befehlszeile auszuführen.

      Mit dem folgenden Befehl wird beispielsweise das IngestAudienceMembers-Beispiel ausgeführt und eine Nutzungsanweisung ausgegeben:

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

      Um Ihnen den Einstieg mit einigen Beispieldaten zu erleichtern, können Sie die Datei unter data-manager-samples/src/main/resources/sampledata/audience_members_1.csv verwenden.

Python

  1. Laden Sie ads-datamanager-v1-py.tar.gz herunter.
  2. Rufen Sie das Verzeichnis des Downloads auf.
  3. Führen Sie den folgenden Befehl aus, um die Bibliothek zu erstellen und für andere Projekte in derselben Python-Umgebung verfügbar zu machen:

    pip install ./ads-datamanager-v1-py.tar.gz
    
  4. Geben Sie in Ihrem Python-Projekt eine Abhängigkeit von der Data Manager API-Bibliothek an. Wenn Sie beispielsweise eine requirements.txt-Datei in Ihrem Projekt verwenden, fügen Sie der Datei die folgende Zeile hinzu:

    google-ads-data-manager=0.1.0
    
  5. Optional: Dienstprogrammbibliothek und Codebeispiele abrufen

    1. Laden Sie data-manager-python.tar.gz herunter und entpacken Sie die Datei.
    2. Rufen Sie das Verzeichnis data-manager-python auf.
    3. Führen Sie den folgenden Befehl aus, um die Utility-Bibliothek in Ihrer Python-Umgebung zu installieren:

      pip install .
      
    4. Geben Sie in Ihrem Python-Projekt eine Abhängigkeit von der Hilfsbibliothek an. Wenn Sie beispielsweise eine requirements.txt-Datei in Ihrem Projekt verwenden, fügen Sie der Datei die folgende Zeile hinzu:

      google-ads-data-manager-util=0.1.0
      
    5. Verwenden Sie zum Formatieren und Verschlüsseln der Daten die Dienstprogramme Formatter und Encrypter in Ihrem Python-Projekt.

    6. Sehen Sie sich die Codebeispiele im Unterverzeichnis samples an. Übergeben Sie das Argument --help, wenn Sie ein Beispiel ausführen, um eine Nutzungsanweisung mit den erwarteten Parametern auszugeben.

      Um Ihnen den Einstieg mit einigen Beispieldaten zu erleichtern, können Sie die Datei unter samples/sampledata/audience_members_1.csv verwenden.

Node.js

  1. Laden Sie ads-datamanager-v1-nodejs.tar.gz herunter und entpacken Sie die Datei.
  2. Rufen Sie das Verzeichnis ads-datamanager-v1-nodejs auf.
  3. Führen Sie die folgenden Befehle aus, um die Bibliothek zu kompilieren und in einer .tgz-Datei für die Verwendung mit npm zu packen.

    npm install
    npm pack
    

    Mit den Befehlen wird ein Archiv mit dem Namen google-cloud-datamanager-0.1.0.tgz generiert.

  4. Deklarieren Sie in Ihrem Node.js-Projekt eine Abhängigkeit von der Data Manager API-Bibliothek, indem Sie einen dependencies-Eintrag für den vollständigen Pfad und Dateinamen der google-cloud-datamanager-0.1.0.tgz-Datei hinzufügen.

PHP

  1. Laden Sie google-cloud-ads-datamanager-v1-php.tar.gz herunter und entpacken Sie die Datei.
  2. Rufen Sie das Verzeichnis google-cloud-ads-datamanager-v1-php auf.
  3. Führen Sie den folgenden Befehl aus, um Abhängigkeiten für die Bibliothek aufzulösen:

    composer update --prefer-dist
    
  4. Deklarieren Sie in der Datei composer.json Ihres PHP-Projekts auf demselben Host eine Abhängigkeit von der Data Manager API-Bibliothek. Gehen Sie dazu so vor:

    1. Fügen Sie einen repositories-Abschnitt hinzu, der auf den Speicherort des google-cloud-ads-datamanager-v1-php-Verzeichnisses verweist.

      "repositories" : [
         {
            "type" : "path",
            "url" : "PATH_TO_CLIENT_LIBRARY"
         }
      ]
      
    2. Deklarieren Sie eine Abhängigkeit von der Data Manager API-Bibliothek.

      "require": {
         "googleads/data-manager": "^0.1.0"
      }
      
  5. Optional: Dienstprogrammbibliothek und Codebeispiele abrufen

    1. Laden Sie data-manager-php.tar.gz herunter und entpacken Sie die Datei.
    2. Rufen Sie das Verzeichnis data-manager-php auf.
    3. Führen Sie den folgenden Befehl aus, um Abhängigkeiten für die Bibliothek aufzulösen:

      composer update --prefer-dist
      
    4. Deklarieren Sie in der Datei composer.json Ihres PHP-Projekts auf demselben Host eine Abhängigkeit von der Utility-Bibliothek. Gehen Sie dazu so vor:

      1. Fügen Sie im Abschnitt repositories einen Eintrag hinzu, der auf den Speicherort des Verzeichnisses data-manager-php verweist.

        "repositories" : [
           {
              "type" : "path",
              "url" : "PATH_TO_UTILITY_LIBRARY"
           }
        ]
        
      2. Deklarieren Sie eine Abhängigkeit von der Utility-Bibliothek.

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

      Verwenden Sie das Formatter-Dienstprogramm in Ihrem PHP-Projekt, um Daten zu formatieren.

    5. Sehen Sie sich die Codebeispiele im Unterverzeichnis samples an. So führen Sie die Beispiele aus:

      1. Rufen Sie das Verzeichnis samples auf.

      2. Legen Sie die Umgebungsvariable DATA_MANAGER_PHP_LIB auf den Pfad fest, in dem Sie die Clientbibliothek extrahiert haben.

        export DATA_MANAGER_PHP_LIB="PATH_TO_CLIENT_LIBRARY"
        
      3. Führen Sie den folgenden Befehl aus, um Abhängigkeiten für die Bibliothek aufzulösen:

        composer update --prefer-dist
        
      4. Führen Sie die Beispiele aus und übergeben Sie alle erforderlichen Argumente. Übergeben Sie das Argument --help, wenn Sie ein Beispiel ausführen, um eine Nutzungsanweisung mit den erwarteten Parametern auszugeben.

      Um Ihnen den Einstieg mit einigen Beispieldaten zu erleichtern, können Sie die Datei unter samples/sampledata/audience_members_1.csv verwenden.