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.

Questa pagina è stata tradotta dall'API Cloud Translation.

Guida rapida: gestire i collegamenti degli account Google Analytics utilizzando l'API Amministrazione Google Marketing Platform

In questa guida introduttiva, crei richieste all'API Admin Google Marketing Platform e visualizzi le risposte contenenti l'elenco degli account Google Analytics collegati all'organizzazione Google Marketing Platform specificata.

Puoi completare questa guida rapida utilizzando un SDK di un linguaggio di programmazione nel tuo ambiente locale o l'API REST.

Prerequisiti

Per completare questa guida rapida, devi:

Configurare un progetto Google Cloud e abilitare l'API Admin Google Marketing Platform
Sulla tua macchina locale:
- Installa, inizializza e autenticati con Google Cloud
- Installa l'SDK per la tua lingua

Configura un progetto Google Cloud

Configura il tuo progetto Google Cloud e abilita l'API Admin Google Marketing Platform.

Fai clic su questo pulsante per selezionare o creare un nuovo progetto Google Cloud e attivare automaticamente l'API Admin Google Marketing Platform:

Configurare Google Cloud

Sulla tua macchina locale, configura e autenticati con Google Cloud.

Installa e inizializza Google Cloud.
Se hai già installato Google Cloud, assicurati che i componenti gcloud siano aggiornati eseguendo questo comando.
```
gcloud components update
```
Per autenticarti con Google Cloud, genera un file di credenziali predefinite dell'applicazione (ADC) locale eseguendo questo comando. Il flusso web avviato dal comando viene utilizzato per fornire le credenziali utente.
```
gcloud auth application-default login --scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/marketingplatformadmin.analytics.read"
```
Tieni presente che gli ambiti richiesti dall'API Admin di Google Marketing Platform sono specificati nel comando.

Per ulteriori informazioni, consulta Configurare le credenziali predefinite dell'applicazione.

L'API Admin Google Marketing Platform richiede un progetto quota, che non è impostato per impostazione predefinita. Per scoprire come impostare il progetto quota, consulta la Guida alle credenziali utente.

Identifica l'ID organizzazione Google Marketing Platform

Per utilizzare l'API Admin Google Marketing Platform, devi identificare l'ID organizzazione Google Marketing Platform. Accedi a Google Marketing Platform, vai alla finestra di dialogo Amministrazione, seleziona la tua organizzazione e prendi nota dell'ID organizzazione in Dettagli organizzazione.

Tutte le richieste all'API Admin Google Marketing Platform devono includere l'ID organizzazione nel formatoorganizations/ORGANIZATION_ID.

Configura l'SDK per il tuo linguaggio di programmazione

Sulla tua macchina locale, fai clic su una delle seguenti schede per installare l'SDK per il tuo linguaggio di programmazione.

REST

Configura le variabili di ambiente inserendo quanto segue.

Sostituisci ORGANIZATION_ID con l'ID della tua organizzazione Google Marketing Platform.
Sostituisci PROJECT_ID con l'ID del tuo progetto Google Cloud.

Esegui una chiamata API

Ora puoi utilizzare l'API Google Marketing Platform per elencare gli account Google Analytics collegati all'organizzazione Google Marketing Platform specificata. Esegui il codice seguente per effettuare la prima chiamata all'API:

Java

Rimuovi le chiamate a .setPageSize e .setPageToken quando esegui la guida rapida.

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

Apri in Cloud Shell Visualizza su 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

Apri in Cloud Shell Visualizza su 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

Apri in Cloud Shell Visualizza su 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

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

packages/google-marketingplatform-admin/samples/quickstart.js

Apri in Cloud Shell Visualizza su 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

Apri in Cloud Shell Visualizza su 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

Per inviare questa richiesta, esegui il comando curl dalla riga di comando o includi la chiamata REST nella tua applicazione.

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

Il codice di esempio stampa una risposta con un elenco di account Google Analytics collegati all'organizzazione Google Marketing Platform specificata:

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

Complimenti! Hai inviato la tua prima richiesta all'API Google Marketing Platform.

Guida rapida: gestire i collegamenti degli account Google Analytics utilizzando l'API Amministrazione Google Marketing Platform Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Prerequisiti

Configura un progetto Google Cloud

Configurare Google Cloud

Identifica l'ID organizzazione Google Marketing Platform

Configura l'SDK per il tuo linguaggio di programmazione

Java

PHP

Python

Node.js

.NET

Ruby

REST

Esegui una chiamata API

Java

PHP

Python

Node.js

.NET

REST

Guida rapida: gestire i collegamenti degli account Google Analytics utilizzando l'API Amministrazione Google Marketing Platform