בדף הזה מוסבר איך להתחיל להשתמש ב-Google Analytics Admin API בשפת התכנות המועדפת עליכם באמצעות ספריות הלקוח.
שלב 1. הפעלת ה-API
ניתן ללחוץ על הלחצן הזה כדי ליצור פרויקט חדש ב-Cloud Platform ולהפעיל באופן אוטומטי את Google Analytics Admin API:
מפעילים את Google Analytics Admin APIבתיבת הדו-שיח שמופיעה, לחצו על הורדה של הגדרת לקוח ושמרו את הקובץ credentials.json בספריית העבודה שלכם.
שלב 2. הגדרת האימות
האפליקציה הזו מדגימה את השימוש ב-Google Analytics Admin API באמצעות פרטי כניסה לחשבון שירות.
מידע נוסף לקבלת הוראות ליצירה ולהגדרה של פרטי כניסה לחשבון שירות באפליקציה.
דרך קלה לספק פרטי כניסה לחשבון שירות היא להגדיר את משתנה הסביבה GOOGLE_APPLICATION_CREDENTIALS, לקוח ה-API ישתמש בערך של המשתנה הזה כדי למצוא את קובץ ה-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
go get google.golang.org/genproto/googleapis/analytics/admin/v1alpha
.NET
ביצוע קריאה ל-API
עכשיו אתם יכולים להשתמש ב-Google Analytics Admin API כדי להציג את רשימת חשבונות Google Analytics. מריצים את הקוד הבא כדי לבצע את הקריאה הראשונה ל-API:
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
Go
.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.