در این شروع سریع، درخواست‌هایی را برای API مدیریت پلتفرم بازاریابی Google ایجاد می‌کنید و پاسخ‌های حاوی فهرست حساب‌های Google Analytics مرتبط با سازمان مشخص شده Google Marketing Platform را مشاهده می‌کنید.
می توانید این شروع سریع را با استفاده از یک SDK زبان برنامه نویسی در محیط محلی خود یا REST API تکمیل کنید.
پیش نیازها
تکمیل این شروع سریع به شما نیاز دارد:
- یک پروژه Google Cloud راه اندازی کنید و 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 راه‌اندازی و احراز هویت کنید.
Google Cloud را نصب و مقداردهی اولیه کنید .
اگر قبلاً Google Cloud را نصب کرده‌اید، با اجرای این دستور مطمئن شوید که اجزای
gcloudشما به‌روزرسانی می‌شوند.gcloud components update
برای احراز هویت با 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 زبان برنامه نویسی خود را نصب کنید.
جاوا
PHP
پایتون
Node.js
دات نت
روبی
استراحت
با وارد کردن موارد زیر متغیرهای محیط خود را پیکربندی کنید.
- شناسه سازمان Google Marketing Platform خود را جایگزین
ORGANIZATION_IDکنید. - شناسه پروژه Google Cloud خود را جایگزین
PROJECT_IDکنید.
یک تماس API برقرار کنید
اکنون می‌توانید از Google Marketing Platform API برای فهرست کردن پیوند حساب‌های Google Analytics به سازمان مشخص شده Google Marketing Platform استفاده کنید. کد زیر را برای انجام اولین تماس خود با API اجرا کنید:
جاوا
هنگام اجرای سریع شروع، تماس های .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); }
پایتون
# 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 organisations/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();
دات نت
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; } }
استراحت
برای ارسال این درخواست، دستور 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 ارسال کرده اید.