The Google Marketing Platform Admin API is in Alpha. Alpha is an unstable early preview stage. For official announcements about this API, subscribe to the Google Marketing Platform API Notify Group.

Ta strona została przetłumaczona przez Cloud Translation API.

Szybki start: zarządzanie połączeniami kont Google Analytics za pomocą interfejsu Google Marketing Platform Admin API

W tym samouczku utworzysz żądania do interfejsu Google Marketing Platform Admin API i wyświetlisz odpowiedzi zawierające listę kont Google Analytics połączonych z wybraną organizacją w Google Marketing Platform.

Możesz ukończyć to krótkie wprowadzenie, korzystając z pakietu SDK języka programowania w środowisku lokalnym lub z interfejsu API REST.

Wymagania wstępne

Aby ukończyć to krótkie wprowadzenie, musisz:

Konfigurowanie projektu Google Cloud i włączanie interfejsu Google Marketing Platform Admin API
Na komputerze lokalnym:
- Instalowanie, inicjowanie i uwierzytelnianie się w Google Cloud
- Instalowanie pakietu SDK dla wybranego języka

Konfigurowanie projektu Google Cloud

skonfigurować projekt Google Cloud i włączyć interfejs Google Marketing Platform Admin API;

Kliknij to przycisk, aby wybrać lub utworzyć nowy projekt Google Cloud i automatycznie włączyć interfejs Google Marketing Platform Admin API:

Konfigurowanie Google Cloud

Na komputerze lokalnym skonfiguruj Google Cloud i zaloguj się w usłudze.

Zainstaluj i inicjuj Google Cloud.
Jeśli Google Cloud został wcześniej zainstalowany, uruchom to polecenie, aby sprawdzić, czy komponenty gcloud zostały zaktualizowane.
```
gcloud components update
```
Aby uwierzytelnić się w Google Cloud, wygeneruj lokalny plik domyślnego uwierzytelniania aplikacji (ADC) przez uruchomienie tego polecenia. Przepływ danych w internecie uruchomiony przez to polecenie służy do podawania danych logowania użytkownika.
```
gcloud auth application-default login --scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/marketingplatformadmin.analytics.read"
```
Zwróć uwagę, jak w komendach są określone zakresy wymagane przez interfejs API Admin Google Marketing Platform.

Więcej informacji znajdziesz w artykule Konfigurowanie domyślnego uwierzytelniania aplikacji.

Interfejs Google Marketing Platform Admin API wymaga projektu z limitem, który nie jest domyślnie ustawiany. Informacje o tym, jak ustawić projekt limitu, znajdziesz w przewodniku po danych logowania użytkownika.

Określanie identyfikatora organizacji Google Marketing Platform

Aby korzystać z interfejsu Google Marketing Platform Admin API, musisz podać identyfikator organizacji Google Marketing Platform. Zaloguj się w Google Marketing Platform, otwórz okno Administracja, wybierz swoją organizację i zapisz identyfikator organizacji w sekcji Szczegóły organizacji.

Wszystkie żądania wysyłane do interfejsu Google Marketing Platform Admin API muszą zawierać identyfikator organizacji w formacie organizations/ORGANIZATION_ID.

Konfigurowanie pakietu SDK pod kątem języka programowania

Na komputerze lokalnym kliknij jedną z tych kart, aby zainstalować pakiet SDK dla wybranego języka programowania.

REST

Aby skonfigurować zmienne środowiskowe, wpisz:

Zastąp ORGANIZATION_ID identyfikatorem organizacji Google Marketing Platform.
Zastąp PROJECT_ID identyfikatorem projektu Google Cloud.

Wywoływanie interfejsu API

Teraz możesz używać interfejsu API Google Marketing Platform, aby wyświetlić listę kont Google Analytics połączonych z wybraną organizacją w Google Marketing Platform. Aby wykonać pierwsze wywołanie interfejsu API, uruchom ten kod:

Java

Usuń połączenia z numerami .setPageSize i .setPageToken podczas uruchamiania krótkiego wprowadzenia.

java-marketingplatformadminapi/samples/snippets/generated/com/google/ads/marketingplatform/admin/v1alpha/marketingplatformadminservice/listanalyticsaccountlinks/SyncListAnalyticsAccountLinks.java

Otwórz w Cloud Shell Wyświetl w GitHubie

import com.google.ads.marketingplatform.admin.v1alpha.AnalyticsAccountLink;
import com.google.ads.marketingplatform.admin.v1alpha.ListAnalyticsAccountLinksRequest;
import com.google.ads.marketingplatform.admin.v1alpha.MarketingplatformAdminServiceClient;
import com.google.ads.marketingplatform.admin.v1alpha.OrganizationName;

public class SyncListAnalyticsAccountLinks {

  public static void main(String[] args) throws Exception {
    syncListAnalyticsAccountLinks();
  }

  public static void syncListAnalyticsAccountLinks() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (MarketingplatformAdminServiceClient marketingplatformAdminServiceClient =
        MarketingplatformAdminServiceClient.create()) {
      ListAnalyticsAccountLinksRequest request =
          ListAnalyticsAccountLinksRequest.newBuilder()
              .setParent(OrganizationName.of("[ORGANIZATION]").toString())
              .setPageSize(883849137)
              .setPageToken("pageToken873572522")
              .build();
      for (AnalyticsAccountLink element :
          marketingplatformAdminServiceClient.listAnalyticsAccountLinks(request).iterateAll()) {
        // doThingsWith(element);
      }
    }
  }
}SyncListAnalyticsAccountLinks.java

peso

samples/V1alpha/MarketingplatformAdminServiceClient/list_analytics_account_links.php

Otwórz w Cloud Shell Wyświetl w GitHubie

use Google\Ads\MarketingPlatform\Admin\V1alpha\AnalyticsAccountLink;
use Google\Ads\MarketingPlatform\Admin\V1alpha\Client\MarketingplatformAdminServiceClient;
use Google\Ads\MarketingPlatform\Admin\V1alpha\ListAnalyticsAccountLinksRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

/**
 * Lists the Google Analytics accounts link to the specified Google Marketing
 * Platform organization.
 *
 * @param string $formattedParent The parent organization, which owns this collection of Analytics
 *                                account links. Format: organizations/{org_id}
 *                                Please see {@see MarketingplatformAdminServiceClient::organizationName()} for help formatting this field.
 */
function list_analytics_account_links_sample(string $formattedParent): void
{
    // Create a client.
    $marketingplatformAdminServiceClient = new MarketingplatformAdminServiceClient();

    // Prepare the request message.
    $request = (new ListAnalyticsAccountLinksRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $marketingplatformAdminServiceClient->listAnalyticsAccountLinks($request);

        /** @var AnalyticsAccountLink $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = MarketingplatformAdminServiceClient::organizationName('[ORGANIZATION]');

    list_analytics_account_links_sample($formattedParent);
}list_analytics_account_links.php

Python

packages/google-ads-marketingplatform-admin/samples/generated_samples/marketingplatformadmin_v1alpha_generated_marketingplatform_admin_service_list_analytics_account_links_sync.py

Otwórz w Cloud Shell Wyświetl w GitHubie

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.ads import marketingplatform_admin_v1alpha


def sample_list_analytics_account_links():
    # Create a client
    client = marketingplatform_admin_v1alpha.MarketingplatformAdminServiceClient()

    # Initialize request argument(s)
    request = marketingplatform_admin_v1alpha.ListAnalyticsAccountLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_analytics_account_links(request=request)

    # Handle the response
    for response in page_result:
        print(response)
marketingplatformadmin_v1alpha_generated_marketingplatform_admin_service_list_analytics_account_links_sync.py

Node.js

Sposób użycia: node packages/google-marketing-platform-admin/samples/quickstart.js organizations/ORGANIZATION_ID.

packages/google-marketing-platform-admin/samples/quickstart.js

Otwórz w Cloud Shell Wyświetl w GitHubie

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent organization, which owns this collection of Analytics
   *  account links. Format: organizations/{org_id}
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of Analytics account links to return in one
   *  call. The service may return fewer than this value.
   *  If unspecified, at most 50 Analytics account links will be returned. The
   *  maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous ListAnalyticsAccountLinks
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListAnalyticsAccountLinks` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

  // Imports the Admin library
  const {MarketingplatformAdminServiceClient} =
    require('@google-ads/marketing-platform-admin').v1alpha;

  // Instantiates a client
  const adminClient = new MarketingplatformAdminServiceClient({fallback: true});

  async function callListAnalyticsAccountLinks() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = adminClient.listAnalyticsAccountLinksAsync(request);
    for await (const response of iterable) {
      console.log(response);
    }
  }

  callListAnalyticsAccountLinks();quickstart.js

.NET

apis/Google.Ads.MarketingPlatform.Admin.V1Alpha/Google.Ads.MarketingPlatform.Admin.V1Alpha.GeneratedSnippets/MarketingplatformAdminServiceClient.ListAnalyticsAccountLinksSnippet.g.cs

Otwórz w Cloud Shell Wyświetl w GitHubie

    using Google.Ads.MarketingPlatform.Admin.V1Alpha;
    using Google.Api.Gax;
    using System;

    public sealed partial class GeneratedMarketingplatformAdminServiceClientSnippets
    {
        /// <summary>Snippet for ListAnalyticsAccountLinks</summary>
        /// <remarks>
        /// This snippet has been automatically generated and should be regarded as a code template only.
        /// It will require modifications to work:
        /// - It may require correct/in-range values for request initialization.
        /// - It may require specifying regional endpoints when creating the service client as shown in
        ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
        /// </remarks>
        public void ListAnalyticsAccountLinks()
        {
            // Create client
            MarketingplatformAdminServiceClient marketingplatformAdminServiceClient = MarketingplatformAdminServiceClient.Create();
            // Initialize request argument(s)
            string parent = "organizations/[ORGANIZATION]";
            // Make the request
            PagedEnumerable<ListAnalyticsAccountLinksResponse, AnalyticsAccountLink> response = marketingplatformAdminServiceClient.ListAnalyticsAccountLinks(parent);

            // Iterate over all response items, lazily performing RPCs as required
            foreach (AnalyticsAccountLink item in response)
            {
                // Do something with each item
                Console.WriteLine(item);
            }

            // Or iterate over pages (of server-defined size), performing one RPC per page
            foreach (ListAnalyticsAccountLinksResponse page in response.AsRawResponses())
            {
                // Do something with each page of items
                Console.WriteLine("A page of results:");
                foreach (AnalyticsAccountLink item in page)
                {
                    // Do something with each item
                    Console.WriteLine(item);
                }
            }

            // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
            int pageSize = 10;
            Page<AnalyticsAccountLink> singlePage = response.ReadPage(pageSize);
            // Do something with the page of items
            Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
            foreach (AnalyticsAccountLink item in singlePage)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
            // Store the pageToken, for when the next page is required.
            string nextPageToken = singlePage.NextPageToken;
        }
    }MarketingplatformAdminServiceClient.ListAnalyticsAccountLinksSnippet.g.cs

REST

Aby wysłać to żądanie, uruchom polecenie curl z wiersza poleceń lub dodaj wywołanie REST w aplikacji.

curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \\
  -H "x-goog-user-project: ${PROJECT_ID}"
  -H "Content-Type: application/json" \\
  https://marketingplatformadmin.googleapis.com/v1alpha/organizations/${ORGANIZATION_ID}/analyticsAccountLinks

Przykładowy kod wypisuje odpowiedź z listą kont Google Analytics połączonych z wybraną organizacją Google Marketing Platform:

{
  "analyticsAccountLinks": [
    {
      "name": "organizations/0a123456789-wxyz/analyticsAccountLinks/1234567890",
      "analyticsAccount": "analyticsadmin.googleapis.com/accounts/1234567890",
      "displayName": "Demo Account",
      "linkVerificationState": "LINK_VERIFICATION_STATE_VERIFIED"
    }
  ]
}

Gratulacje! Udało Ci się wysłać pierwsze żądanie do interfejsu Google Marketing Platform API.

Szybki start: zarządzanie połączeniami kont Google Analytics za pomocą interfejsu Google Marketing Platform Admin API Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Wymagania wstępne

Konfigurowanie projektu Google Cloud

Konfigurowanie Google Cloud

Określanie identyfikatora organizacji Google Marketing Platform

Konfigurowanie pakietu SDK pod kątem języka programowania

Java

peso

Python

Node.js

.NET

Ruby

REST

Wywoływanie interfejsu API

Java

peso

Python

Node.js

.NET

REST

Szybki start: zarządzanie połączeniami kont Google Analytics za pomocą interfejsu Google Marketing Platform Admin API