Panduan memulai cepat: Mengelola penautan akun Google Analytics menggunakan Google Marketing Platform Admin API

Dalam panduan memulai ini, Anda akan membuat permintaan ke Admin API Google Marketing Platform dan melihat respons yang berisi daftar akun Google Analytics yang ditautkan ke organisasi Google Marketing Platform yang ditentukan.

Anda dapat menyelesaikan panduan memulai ini dengan menggunakan SDK bahasa pemrograman di lingkungan lokal atau REST API.

Prasyarat

Untuk menyelesaikan panduan memulai ini, Anda harus:

  • Menyiapkan project Google Cloud dan mengaktifkan Admin API Google Marketing Platform
  • Di komputer lokal Anda:
    • Menginstal, melakukan inisialisasi, dan mengautentikasi dengan Google Cloud
    • Menginstal SDK untuk bahasa Anda

Menyiapkan project Google Cloud

Siapkan project Google Cloud Anda dan aktifkan Admin API Google Marketing Platform.

Klik tombol ini untuk memilih atau membuat project Google Cloud baru dan mengaktifkan Admin API Google Marketing Platform secara otomatis:

Mengaktifkan Admin API Google Marketing Platform

Menyiapkan Google Cloud

Di komputer lokal Anda, siapkan dan lakukan autentikasi dengan Google Cloud.

  1. Instal dan lakukan inisialisasi Google Cloud.

  2. Jika sebelumnya Anda menginstal Google Cloud, pastikan komponen gcloud Anda diupdate dengan menjalankan perintah ini.

    gcloud components update

  3. Untuk melakukan autentikasi dengan Google Cloud, buat file Kredensial Default Aplikasi (ADC) lokal dengan menjalankan perintah ini. Alur web yang diluncurkan oleh perintah ini digunakan untuk memberikan kredensial pengguna Anda.

    gcloud auth application-default login --scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/marketingplatformadmin.analytics.read"

    Perhatikan cara cakupan yang diperlukan oleh Google Marketing Platform Admin API ditentukan dalam perintah.

    Untuk informasi selengkapnya, lihat Menyiapkan Kredensial Default Aplikasi.

Admin API Google Marketing Platform memerlukan project kuota, yang tidak ditetapkan secara default. Untuk mempelajari cara menetapkan project kuota, lihat Panduan Kredensial Pengguna.

Mengidentifikasi ID organisasi Google Marketing Platform Anda

Untuk menggunakan Admin API Google Marketing Platform, Anda perlu mengidentifikasi ID organisasi Google Marketing Platform Anda. Login ke Google Marketing Platform, buka dialog Administrasi, pilih organisasi Anda, dan catat ID Organisasi di bagian Detail organisasi.

Semua permintaan ke Admin API Google Marketing Platform harus menyertakan ID organisasi dalam format organizations/ORGANIZATION_ID.

Menyiapkan SDK untuk bahasa pemrograman Anda

Di komputer lokal, klik salah satu tab berikut untuk menginstal SDK untuk bahasa pemrograman Anda.

Java

Panduan penginstalan library klien Java

PHP

Panduan penginstalan library klien PHP

Python

Panduan penginstalan library klien Python

Node.js

Panduan penginstalan library klien Node.js

.NET

Panduan penginstalan library klien .NET

Ruby

Panduan penginstalan library klien Ruby

REST

Konfigurasikan variabel lingkungan Anda dengan memasukkan hal berikut.

  1. Ganti ORGANIZATION_ID dengan ID organisasi Google Marketing Platform Anda.
  2. Ganti PROJECT_ID dengan ID project Google Cloud Anda.

Melakukan panggilan API

Sekarang Anda dapat menggunakan Google Marketing Platform API untuk mencantumkan penautan akun Google Analytics ke organisasi Google Marketing Platform yang ditentukan. Jalankan kode berikut untuk melakukan panggilan pertama ke API:

Java

Hapus panggilan ke .setPageSize dan .setPageToken saat menjalankan panduan memulai.

java-marketingplatformadminapi/samples/snippets/generated/com/google/ads/marketingplatform/admin/v1alpha/marketingplatformadminservice/listanalyticsaccountlinks/SyncListAnalyticsAccountLinks.java
Buka di Cloud Shell Lihat di GitHub 
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

PHP

samples/V1alpha/MarketingplatformAdminServiceClient/list_analytics_account_links.php
Buka di Cloud Shell Lihat di GitHub 
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
Buka di Cloud Shell Lihat di GitHub 
# 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

Penggunaan: node packages/google-marketingplatform-admin/samples/quickstart.js organizations/ORGANIZATION_ID.

packages/google-marketingplatform-admin/samples/quickstart.js
Buka di Cloud Shell Lihat di GitHub 
  /**
   * 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
Buka di Cloud Shell Lihat di GitHub 
    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

Untuk mengirim permintaan ini, jalankan perintah curl dari command line atau sertakan panggilan REST di aplikasi Anda. 

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

Kode contoh mencetak respons dengan daftar akun Google Analytics yang ditautkan ke organisasi Google Marketing Platform yang ditentukan:

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

Selamat! Anda telah mengirimkan permintaan pertama ke Google Marketing Platform API.