เริ่มต้นใช้งานอย่างรวดเร็ว: จัดการลิงก์บัญชี Google Analytics โดยใช้ Google Marketing Platform Admin API

ในบทเริ่มต้นใช้งานนี้ คุณสร้างคําขอไปยัง Google Marketing Platform Admin API และดูคําตอบที่มีรายการบัญชี Google Analytics ที่ลิงก์กับองค์กร Google Marketing Platform ที่ระบุ

คุณสามารถทำตามคู่มือเริ่มต้นใช้งานฉบับย่อนี้ให้เสร็จสมบูรณ์ได้โดยใช้ SDK ภาษาโปรแกรมในสภาพแวดล้อมในเครื่องหรือ REST API

ข้อกำหนดเบื้องต้น

ในการเริ่มต้นใช้งานอย่างรวดเร็วนี้ คุณต้องทำดังนี้

  • ตั้งค่าโปรเจ็กต์ Google Cloud และเปิดใช้ Google Marketing Platform Admin API
  • ในเครื่องของคุณเอง ให้ทำดังนี้
    • ติดตั้ง เริ่มต้นใช้งาน และตรวจสอบสิทธิ์ด้วย Google Cloud
    • ติดตั้ง SDK สำหรับภาษาของคุณ

ตั้งค่าโปรเจ็กต์ Google Cloud

ตั้งค่าโปรเจ็กต์ Google Cloud และเปิดใช้ Google Marketing Platform Admin API

คลิกปุ่มนี้เพื่อเลือกหรือสร้างโปรเจ็กต์ Google Cloud ใหม่ และเปิดใช้ Google Marketing Platform Admin API โดยอัตโนมัติ

เปิดใช้ Google Marketing Platform Admin API

ตั้งค่า Google Cloud

ตั้งค่าและตรวจสอบสิทธิ์กับ Google Cloud ในเครื่องของคุณ

  1. ติดตั้งและเริ่มต้นใช้งาน Google Cloud

  2. หากคุณติดตั้ง Google Cloud ไว้ก่อนหน้านี้ ให้ตรวจสอบว่าคอมโพเนนต์ gcloud ได้รับการอัปเดตแล้วโดยเรียกใช้คําสั่งนี้

    gcloud components update
  3. หากต้องการตรวจสอบสิทธิ์กับ Google Cloud ให้สร้างไฟล์ข้อมูลเข้าสู่ระบบเริ่มต้นของแอปพลิเคชัน (ADC) ในพื้นที่โดยเรียกใช้คําสั่งนี้ ระบบจะใช้ขั้นตอนการทํางานบนเว็บที่เปิดใช้งานโดยคําสั่งนี้เพื่อระบุข้อมูลเข้าสู่ระบบของผู้ใช้

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

    โปรดสังเกตวิธีระบุขอบเขตที่จําเป็นสําหรับ Google Marketing Platform Admin API ในคําสั่ง

    โปรดดูข้อมูลเพิ่มเติมที่หัวข้อตั้งค่าข้อมูลเข้าสู่ระบบเริ่มต้นของแอปพลิเคชัน

Google Marketing Platform Admin API ต้องใช้โปรเจ็กต์โควต้า ซึ่งไม่ได้ตั้งค่าไว้โดยค่าเริ่มต้น ดูวิธีตั้งค่าโปรเจ็กต์โควต้าได้ที่คู่มือข้อมูลเข้าสู่ระบบของผู้ใช้

ระบุรหัสองค์กร Google Marketing Platform

หากต้องการใช้ Google Marketing Platform Admin API คุณต้องระบุรหัสองค์กร Google Marketing Platform เข้าสู่ระบบ Google Marketing Platform แล้วไปที่กล่องโต้ตอบการดูแลระบบ เลือกองค์กร แล้วจดรหัสองค์กรไว้ในส่วนรายละเอียดองค์กร

คําขอทั้งหมดที่ส่งไปยัง Google Marketing Platform Admin API ต้องมีรหัสองค์กรในรูปแบบ organizations/ORGANIZATION_ID

ตั้งค่า SDK สำหรับภาษาโปรแกรม

ในเครื่องของคุณ ให้คลิกแท็บใดแท็บหนึ่งต่อไปนี้เพื่อติดตั้ง SDK สําหรับภาษาโปรแกรมของคุณ

เรียก API

ตอนนี้คุณใช้ Google Marketing Platform API เพื่อแสดงรายการบัญชี Google Analytics ที่ลิงก์กับองค์กร Google Marketing Platform ที่ระบุได้แล้ว เรียกใช้โค้ดต่อไปนี้เพื่อเรียก API ครั้งแรก

Java

นําการเรียก .setPageSize และ .setPageToken ออกเมื่อเรียกใช้การเริ่มต้นใช้งานอย่างรวดเร็ว

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);
      }
    }
  }
}

PHP

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);
}

Python

# 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)

Node.js

การใช้งาน: node packages/google-marketingplatform-admin/samples/quickstart.js organizations/ORGANIZATION_ID

  /**
   * 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();

.NET

    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;
        }
    }

REST

หากต้องการส่งคําขอนี้ ให้เรียกใช้คําสั่ง curl จากบรรทัดคําสั่ง หรือรวมการเรียก REST ไว้ในแอปพลิเคชัน

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

โค้ดตัวอย่างจะแสดงผลลัพธ์พร้อมรายการบัญชี Google Analytics ที่ลิงก์กับองค์กร Google Marketing Platform ที่ระบุ

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

ยินดีด้วย คุณได้ส่งคําขอแรกไปยัง Google Marketing Platform API แล้ว