توضّح لك هذه الصفحة كيفية بدء استخدام واجهة برمجة التطبيقات Google Analytics Admin API في لغة البرمجة المفضّلة لديك باستخدام برنامج Libraries (مكتبات العميل).
الخطوة 1. تفعيل واجهة برمجة التطبيقات
انقر على هذا الزر لإنشاء مشروع Cloud Platform جديد وفعِّل تلقائيًا Google Analytics Admin API:
تفعيل Google Analytics Admin APIفي مربّع الحوار الذي يظهر، انقر على تنزيل إعدادات البرنامج واحفظ الملف credentials.jsonفي دليل العمل.
الخطوة 2. ضبط المصادقة
يوضِّح هذا التطبيق استخدام Google Analytics Admin API باستخدام بيانات اعتماد حساب الخدمة.
تعرَّف على المزيد من المعلومات للحصول على تعليمات حول إنشاء بيانات اعتماد حساب الخدمة وضبطها للتطبيق.
تتوفّر طريقة سهلة لتوفير بيانات اعتماد حساب الخدمة من خلال ضبط متغيّر بيئة GOOGLE_APPLICATION_CREDENTIALS، وسيستخدم برنامج واجهة برمجة التطبيقات قيمة هذا المتغيّر للعثور على ملف JSON لمفتاح حساب الخدمة.
لضبط بيانات اعتماد التطبيق في هذا المثال، شغِّل الأمر التالي واستخدِم المسار إلى ملف JSON لحساب الخدمة الذي تم تنزيله في الخطوة 1:
export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"
مثال:
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service_account.json"
الخطوة 3. تثبيت مكتبة البرامج
Java
Python
Node.js
Ruby
البدء
go get google.golang.org/genproto/googleapis/analytics/admin/v1alpha
NET.
إجراء طلب بيانات من واجهة برمجة التطبيقات
يمكنك الآن استخدام Google Analytics Admin API لإدراج حسابات Google Analytics. شغِّل الرمز التالي لإجراء اتصالك الأول بواجهة برمجة التطبيقات:
Java
import com.google.analytics.admin.v1beta.Account;
import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient;
import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient.ListAccountsPage;
import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient.ListAccountsPagedResponse;
import com.google.analytics.admin.v1beta.ListAccountsRequest;
/**
* This application demonstrates the usage of the Analytics Admin API using service account
* credentials. For more information on service accounts, see
* https://cloud.google.com/iam/docs/understanding-service-accounts.
*
* <p>The following document provides instructions on setting service account credentials for your
* application: https://cloud.google.com/docs/authentication/production
*
* <p>In a nutshell, you need to:
*
* <ol>
* <li>Create a service account and download the key JSON file as described at
* https://cloud.google.com/docs/authentication/production#creating_a_service_account.
* <li>Provide service account credentials using one of the following options:
* <ul>
* <li>Set the {@code GOOGLE_APPLICATION_CREDENTIALS} environment variable. The API client
* will use the value of this variable to find the service account key JSON file. See
* https://cloud.google.com/docs/authentication/production#setting_the_environment_variable
* for more information.
* <p>OR
* <li>Manually pass the path to the service account key JSON file to the API client by
* specifying the {@code keyFilename} parameter in the constructor. See
* https://cloud.google.com/docs/authentication/production#passing_the_path_to_the_service_account_key_in_code
* for more information.
* </ul>
* </ol>
*
* <p>To run this sample using Maven:
*
* <pre>{@code
* cd google-analytics-data
* mvn compile exec:java -Dexec.mainClass="com.google.analytics.admin.samples.QuickstartSample"
* }</pre>
*/
public class QuickstartSample {
public static void main(String... args) throws Exception {
listAccounts();
}
// This is an example snippet that calls the Google Analytics Admin API and lists all Google
// Analytics accounts available to the authenticated user.
static void listAccounts() throws Exception {
// Instantiates a client using default credentials.
// See https://cloud.google.com/docs/authentication/production for more information
// about managing credentials.
try (AnalyticsAdminServiceClient analyticsAdmin = AnalyticsAdminServiceClient.create()) {
// Calls listAccounts() method of the Google Analytics Admin API and prints
// the response for each account.
ListAccountsPagedResponse response =
analyticsAdmin.listAccounts(ListAccountsRequest.newBuilder().build());
for (ListAccountsPage page : response.iteratePages()) {
for (Account account : page.iterateAll()) {
System.out.printf("Account name: %s%n", account.getName());
System.out.printf("Display name: %s%n", account.getDisplayName());
System.out.printf("Country code: %s%n", account.getRegionCode());
System.out.printf("Create time: %s%n", account.getCreateTime().getSeconds());
System.out.printf("Update time: %s%n", account.getUpdateTime().getSeconds());
System.out.println();
}
}
}
}
}
Python
def list_accounts(transport: str = None):
"""
Lists the available Google Analytics accounts.
Args:
transport(str): The transport to use. For example, "grpc"
or "rest". If set to None, a transport is chosen automatically.
"""
from google.analytics.admin import AnalyticsAdminServiceClient
# Using a default constructor instructs the client to use the credentials
# specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
client = AnalyticsAdminServiceClient(transport=transport)
results = client.list_accounts()
# Displays the configuration information for all Google Analytics accounts
# available to the authenticated user.
print("Result:")
for account in results:
print(account)
Node.js
// Imports the Google Analytics Admin API client library
const analyticsAdmin = require('@google-analytics/admin');
async function main() {
// Instantiates a client using default credentials.
// TODO(developer): uncomment and use the following line in order to
// manually set the path to the service account JSON file instead of
// using the value from the GOOGLE_APPLICATION_CREDENTIALS environment
// variable.
// const analyticsAdminClient = new analyticsAdmin.AnalyticsAdminServiceClient(
// {keyFilename: "your_key_json_file_path"});
const analyticsAdminClient = new analyticsAdmin.AnalyticsAdminServiceClient();
// Calls listAccounts() method of the Google Analytics Admin API and prints
// the response for each account.
const [accounts] = await analyticsAdminClient.listAccounts();
console.log('Accounts:');
accounts.forEach(account => {
console.log(account);
});
}
main(...process.argv.slice(2)).catch(err => {
console.error(err.message);
process.exitCode = 1;
});
process.on('unhandledRejection', err => {
console.error(err.message);
process.exitCode = 1;
});
Ruby
البدء
NET.
using Google.Analytics.Admin.V1Alpha;
using System;
namespace AnalyticsSamples
{
class QuickStart
{
static void Main(string[] args)
{
var client = AnalyticsAdminServiceClient.Create();
var response = client.ListAccounts( new ListAccountsRequest() );
foreach( Account account in response )
{
Console.WriteLine("Account name: {0}", account.Name);
Console.WriteLine("Display name: {0}", account.DisplayName);
Console.WriteLine("Country code: {0}", account.CountryCode);
Console.WriteLine("Update time: {0}", account.UpdateTime);
Console.WriteLine("Create time: {0}", account.CreateTime);
Console.WriteLine();
}
}
}
}
تهانينا لقد أرسلت طلبك الأول إلى Google Analytics Admin API.