API Campaign Manager 360 предоставляет программный доступ к информации из вашей учетной записи Campaign Manager 360. Он используется для управления кампаниями и создания отчетов, так же, как и через веб-сервисы Campaign Manager 360 и Report Builder.
В этом руководстве описано, как начать работу с API Campaign Manager 360.
Предпосылки
Перед использованием API Campaign Manager 360 необходимо выполнить несколько предварительных шагов:
Для работы вам необходима учетная запись Campaign Manager 360. Информацию о регистрации см. в разделе «Рекламодатели/Агентства» .
Для доступа к API необходимо включить вашу учетную запись Campaign Manager 360. В большинстве учетных записей эта функция включена по умолчанию; если вы не уверены, обратитесь за помощью к своему представителю или в службу поддержки Campaign Manager 360 .
У вас должен быть профиль пользователя с доступом к этой учетной записи. Попросите администратора вашей учетной записи Campaign Manager 360 создать профиль пользователя, связанный с этой учетной записью.
Проверьте права доступа профиля пользователя в пользовательском интерфейсе Campaign Manager 360. Они определяют, к чему может получить доступ профиль пользователя через API. Отдельных прав доступа к API нет.
Создать проект
Для начала работы с API Campaign Manager 360 необходимо сначала создать или выбрать проект в консоли Google API и включить API . Эта ссылка поможет вам выполнить необходимые действия и автоматически активирует API Campaign Manager 360.
Сгенерировать учетные данные
Все запросы к API Campaign Manager 360 должны быть авторизованы. Краткий обзор авторизации можно найти в статье о том, как авторизовать и идентифицировать ваше приложение в Google .
Следующие инструкции помогут вам создать идентификатор клиента OAuth 2.0 для использования с установленным приложением . Инструкции по генерации учетных данных для использования с учетной записью службы см. в руководстве по учетным записям служб .
Выполните следующие шаги для настройки проекта в Google API Console .
- Откройте страницу «Учетные данные» в консоли API.
Нажмите СОЗДАТЬ УЧЕТНЫЕ ДАННЫЕ > Идентификатор клиента OAuth .
Если вы ранее не настраивали экран согласия OAuth для этого проекта, вам будет предложено сделать это сейчас. Нажмите «НАСТРОИТЬ ЭКРАН СОГЛАСИЯ» .
Выберите тип пользователя и нажмите «СОЗДАТЬ» .
Заполните первоначальную форму. При необходимости вы сможете отредактировать ее позже. После завершения нажмите «Сохранить» .
Вернитесь в раздел «Учетные данные» > «СОЗДАТЬ УЧЕТНЫЕ ДАННЫЕ» > «Идентификатор клиента OAuth» , чтобы продолжить.
Выберите тип приложения «Настольное приложение» , дайте ему имя, затем нажмите «Создать» .
После завершения вам будет предоставлен идентификатор клиента OAuth 2.0 и секретный ключ клиента, которые вы можете загрузить в формате JSON и сохранить для дальнейшего использования.
Установите клиентскую библиотеку.
API Campaign Manager 360 построен на протоколах HTTP и JSON, поэтому любой стандартный HTTP-клиент может отправлять к нему запросы и анализировать ответы.
Однако клиентские библиотеки Google API обеспечивают лучшую интеграцию с различными языками программирования, улучшенную безопасность и поддержку авторизованных запросов. Клиентские библиотеки доступны для ряда языков программирования; используя их, вы можете избежать необходимости вручную настраивать HTTP-запросы и анализировать ответы.
Для начала выберите язык программирования, который вы используете для разработки.
C#
Установите последнюю версию клиентской библиотеки API Campaign Manager 360 для .NET . Рекомендуется использовать NuGet для управления установкой.
Откройте консоль диспетчера пакетов NuGet и выполните следующую команду:
Install-Package Google.Apis.Dfareporting.v3_4
Узнать больше
Java
Установите последнюю версию клиентской библиотеки API Campaign Manager 360 для Java . Рекомендуется использовать Maven для управления установкой.
Добавьте следующую зависимость в ваш файл pom.xml :
<dependency> <groupId>com.google.apis</groupId> <artifactId>google-api-services-dfareporting</artifactId> <version>v4-rev20250722-2.0.0</version> <exclusions> <exclusion> <groupId>com.google.guava</groupId> <artifactId>guava-jdk5</artifactId> </exclusion> </exclusions> </dependency>
Узнать больше
PHP
Установите последнюю версию клиентской библиотеки Campaign Manager 360 API для PHP . Рекомендуется использовать Composer для управления установкой.
Откройте терминал и выполните следующую команду:
composer require google/apiclient
Если вы уже установили библиотеку и просто хотите обновить её до последней версии:
composer update google/apiclient
В зависимости от вашей системы, возможно, потребуется добавить перед этими командами префикс sudo .
Узнать больше
Python
Установите последнюю версию клиентской библиотеки API Campaign Manager 360 для Python . Рекомендуется использовать pip для управления установкой.
Откройте терминал и выполните следующую команду:
pip install --upgrade google-api-python-client
В зависимости от вашей системы, возможно, потребуется добавить перед этими командами префикс sudo .
Узнать больше
Руби
Установите последнюю версию клиентской библиотеки API Campaign Manager 360 для Ruby . Рекомендуется использовать RubyGems для управления установкой.
Откройте терминал и выполните следующую команду:
gem install google-api-client
Если вы уже установили библиотеку и просто хотите обновить её до последней версии:
gem update -y google-api-client
В зависимости от вашей системы, возможно, потребуется добавить перед этими командами префикс sudo .
Узнать больше
Список поддерживаемых языков можно найти на странице «Библиотеки клиентов» .
Сделать запрос
После создания учетных данных OAuth 2.0 и установки клиентской библиотеки вы готовы начать использовать API Campaign Manager 360. Узнайте, как авторизоваться, настроить клиент и отправить первый запрос, следуя приведенному ниже краткому руководству.
C#
Загрузите файл с секретами клиента и сгенерируйте учетные данные для авторизации.
При первом выполнении этого шага вам будет предложено принять запрос на авторизацию в вашем браузере. Прежде чем принять его, убедитесь, что вы вошли в систему с учетной записью Google, имеющей доступ к Campaign Manager 360. Ваше приложение будет авторизовано для доступа к данным от имени той учетной записи, которая в данный момент авторизована.
// Load client secrets from the specified JSON file. GoogleClientSecrets clientSecrets; using(Stream json = new FileStream(pathToJsonFile, FileMode.Open, FileAccess.Read)) { clientSecrets = GoogleClientSecrets.Load(json); } // Create an asynchronous authorization task. // // Note: providing a data store allows auth credentials to be cached, so they survive multiple // runs of the application. This avoids prompting the user for authorization every time the // access token expires, by remembering the refresh token. The "user" value is used to // identify a specific set of credentials within the data store. You may provide different // values here to persist credentials for multiple users to the same data store. Task<UserCredential> authorizationTask = GoogleWebAuthorizationBroker.AuthorizeAsync( clientSecrets.Secrets, OAuthScopes, "user", CancellationToken.None, dataStore); // Authorize and persist credentials to the data store. UserCredential credential = authorizationTask.Result;
Создайте авторизованный клиент Dfareporting.
// Create a Dfareporting service object. // // Note: application name should be replaced with a value that identifies your application. service = new DfareportingService( new BaseClientService.Initializer { HttpClientInitializer = credential, ApplicationName = "C# installed app sample" } );
Выполнить операцию.
// Retrieve and print all user profiles for the current authorized user. UserProfileList profiles = service.UserProfiles.List().Execute(); foreach (UserProfile profile in profiles.Items) { Console.WriteLine("Found user profile with ID {0} and name \"{1}\".", profile.ProfileId, profile.UserName); }
Java
Загрузите файл с секретами клиента и сгенерируйте учетные данные для авторизации.
При первом выполнении этого шага вам будет предложено принять запрос на авторизацию в вашем браузере. Прежде чем принять его, убедитесь, что вы вошли в систему с учетной записью Google, имеющей доступ к Campaign Manager 360. Ваше приложение будет авторизовано для доступа к данным от имени той учетной записи, которая в данный момент авторизована.
// Load the client secrets JSON file. GoogleClientSecrets clientSecrets = GoogleClientSecrets.load( jsonFactory, Files.newBufferedReader(Paths.get(pathToClientSecretsFile), UTF_8)); // Set up the authorization code flow. // // Note: providing a DataStoreFactory allows auth credentials to be cached, so they survive // multiple runs of the program. This avoids prompting the user for authorization every time the // access token expires, by remembering the refresh token. GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder( httpTransport, jsonFactory, clientSecrets, OAUTH_SCOPES) .setDataStoreFactory(dataStoreFactory) .build(); // Authorize and persist credentials to the data store. // // Note: the "user" value below is used to identify a specific set of credentials in the data // store. You may provide different values here to persist credentials for multiple users to // the same data store. Credential credential = new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");
Создайте авторизованный клиент Dfareporting.
// Create a Dfareporting client instance. // // Note: application name below should be replaced with a value that identifies your // application. Suggested format is "MyCompany-ProductName/Version.MinorVersion". Dfareporting reporting = new Dfareporting.Builder(credential.getTransport(), credential.getJsonFactory(), credential) .setApplicationName("dfareporting-java-installed-app-sample") .build();
Выполнить операцию.
// Retrieve and print all user profiles for the current authorized user. UserProfileList profiles = reporting.userProfiles().list().execute(); for (int i = 0; i < profiles.getItems().size(); i++) { System.out.printf("%d) %s%n", i + 1, profiles.getItems().get(i).getUserName()); }
PHP
Загрузите файл с секретами клиента и сгенерируйте учетные данные для авторизации.
При первом выполнении этого шага вам будет предложено принять запрос на авторизацию в вашем браузере. Прежде чем принять его, убедитесь, что вы вошли в систему с учетной записью Google, имеющей доступ к Campaign Manager 360. Ваше приложение будет авторизовано для доступа к данным от имени той учетной записи, которая в данный момент авторизована.
// Create a Google_Client instance. // // Note: application name should be replaced with a value that identifies // your application. Suggested format is "MyCompany-ProductName". $client = new Google_Client(); $client->setAccessType('offline'); $client->setApplicationName('PHP installed app sample'); $client->setRedirectUri(self::OAUTH_REDIRECT_URI); $client->setScopes(self::$OAUTH_SCOPES); // Load the client secrets file. $client->setAuthConfig($pathToJsonFile); // Try to load cached credentials from the token store. Using a token store // allows auth credentials to be cached, so they survive multiple runs of // the application. This avoids prompting the user for authorization every // time the access token expires, by remembering the refresh token. if (file_exists($tokenStore) && filesize($tokenStore) > 0) { $client->setAccessToken(file_get_contents($tokenStore)); } else { // If no cached credentials were found, authorize and persist // credentials to the token store. print 'Open this URL in your browser and authorize the application.'; printf("\n\n%s\n\n", $client->createAuthUrl()); print 'Enter the authorization code: '; $code = trim(fgets(STDIN)); $client->authenticate($code); file_put_contents($tokenStore, json_encode($client->getAccessToken())); }
Создайте авторизованный клиент Dfareporting.
// Create a Dfareporting service object. $service = new Google_Service_Dfareporting($client);
Выполнить операцию.
// Retrieve and print all user profiles for the current authorized user. $result = $service->userProfiles->listUserProfiles(); foreach ($result['items'] as $userProfile) { printf( "User profile \"%s\" (ID: %d) found for account %d.\n", $userProfile->getUserName(), $userProfile->getProfileId(), $userProfile->getAccountId() ); }
Python
Загрузите файл с секретами клиента и сгенерируйте учетные данные для авторизации.
При первом выполнении этого шага вам будет предложено принять запрос на авторизацию в вашем браузере. Прежде чем принять его, убедитесь, что вы вошли в систему с учетной записью Google, имеющей доступ к Campaign Manager 360. Ваше приложение будет авторизовано для доступа к данным от имени той учетной записи, которая в данный момент авторизована.
# Set up a Flow object to be used if we need to authenticate. flow = client.flow_from_clientsecrets( path_to_client_secrets_file, scope=OAUTH_SCOPES) # Check whether credentials exist in the credential store. Using a credential # store allows auth credentials to be cached, so they survive multiple runs # of the application. This avoids prompting the user for authorization every # time the access token expires, by remembering the refresh token. storage = Storage(CREDENTIAL_STORE_FILE) credentials = storage.get() # If no credentials were found, go through the authorization process and # persist credentials to the credential store. if credentials is None or credentials.invalid: credentials = tools.run_flow(flow, storage, tools.argparser.parse_known_args()[0]) # Use the credentials to authorize an httplib2.Http instance. http = credentials.authorize(httplib2.Http())
Создайте авторизованный клиент Dfareporting.
# Construct a service object via the discovery service. service = discovery.build('dfareporting', 'v4', http=http)
Выполнить операцию.
# Construct the request. request = service.userProfiles().list() # Execute request and print response. response = request.execute() for profile in response['items']: print('Found user profile with ID %s and user name "%s".' % (profile['profileId'], profile['userName']))
Руби
Загрузите файл с секретами клиента и сгенерируйте учетные данные для авторизации.
При первом выполнении этого шага вам будет предложено принять запрос на авторизацию в вашем браузере. Прежде чем принять его, убедитесь, что вы вошли в систему с учетной записью Google, имеющей доступ к Campaign Manager 360. Ваше приложение будет авторизовано для доступа к данным от имени той учетной записи, которая в данный момент авторизована.
# Load client ID from the specified file. client_id = Google::Auth::ClientId.from_file(path_to_json_file) # Set up the user authorizer. # # Note: providing a token store allows auth credentials to be cached, so they # survive multiple runs of the application. This avoids prompting the user for # authorization every time the access token expires, by remembering the # refresh token. authorizer = Google::Auth::UserAuthorizer.new( client_id, [API_NAMESPACE::AUTH_DFAREPORTING], token_store ) # Authorize and persist credentials to the data store. # # Note: the 'user' value below is used to identify a specific set of # credentials in the token store. You may provide different values here to # persist credentials for multiple users to the same token store. authorization = authorizer.get_credentials('user') if authorization.nil? puts format( "Open this URL in your browser and authorize the application.\n\n%s" \ "\n\nEnter the authorization code:", authorizer.get_authorization_url(base_url: OAUTH_REDIRECT_URI) ) code = STDIN.gets.chomp authorization = authorizer.get_and_store_credentials_from_code( base_url: OAUTH_REDIRECT_URI, code: code, user_id: 'user' ) end
Создайте авторизованный клиент Dfareporting.
# Create a Dfareporting service object. # # Note: application name should be replaced with a value that identifies # your application. Suggested format is "MyCompany-ProductName". service = API_NAMESPACE::DfareportingService.new service.authorization = authorization service.client_options.application_name = 'Ruby installed app sample' service.client_options.application_version = '1.0.0'
Выполнить операцию.
// Retrieve and print all user profiles for the current authorized user. UserProfileList profiles = service.UserProfiles.List().Execute(); foreach (UserProfile profile in profiles.Items) { Console.WriteLine("Found user profile with ID {0} and name \"{1}\".", profile.ProfileId, profile.UserName); }
Узнать больше
Посетите справочник API , чтобы узнать обо всех услугах, которые предлагает API. На каждой странице с подробным описанием метода есть встроенный API Explorer, который можно использовать для выполнения тестовых запросов непосредственно из браузера.
Ознакомьтесь с другими нашими руководствами, которые охватывают сложные темы и содержат подробные примеры решения распространенных задач.
Когда вы будете готовы начать писать код, смело изучайте нашу обширную коллекцию примеров кода , которые можно изменять и расширять в соответствии с вашими потребностями.