L'API Campaign Manager 360 offre un accès programmatique aux informations votre compte Campaign Manager 360. Il est utilisé pour gérer et créer des campagnes et des rapports, comme vous le feriez via les services Web Campaign Manager 360 et l'outil de création de rapports.
Ce guide explique comment utiliser l'API Campaign Manager 360.
Prérequis
Avant d'utiliser l'API Campaign Manager 360, vous devez suivre quelques étapes satisfaire:
Vous devez disposer d'un compte Campaign Manager 360. Voir Annonceurs/Agences pour obtenir des informations sur l'inscription.
L'accès à l'API doit être activé dans votre compte Campaign Manager 360. La plupart cette option est activée par défaut dans les comptes de service. En cas de doute, contactez votre ou l'assistance Campaign Manager 360 pour obtenir de l'aide.
Vous devez disposer d'un profil utilisateur ayant accès à ce compte. Demandez à votre L'administrateur du compte Campaign Manager 360 crée un profil utilisateur associé à ce compte.
Vérifiez les autorisations de profil utilisateur dans l'interface utilisateur de Campaign Manager 360. Ces commandes auquel le profil utilisateur peut accéder depuis l'API. Il n'existe pas d'API distincte autorisations.
Créer un projet
Pour commencer à utiliser l'API Campaign Manager 360, vous devez d'abord créer ou sélectionnez un projet dans la console Google APIs et activez l'API. Utilisation vous guide tout au long du processus et active l'API Campaign Manager 360 automatiquement.
<ph type="x-smartling-placeholder">Générer des identifiants
Toutes les demandes que vous envoyez à l'API Campaign Manager 360 doivent être autorisées. En bref présentation du processus d'autorisation, découvrez comment autoriser et identifier l'application à Google.
Les instructions suivantes vous guident tout au long du processus de création d'un 2.0 à utiliser avec l'application installée le flux de travail. Pour obtenir des instructions sur la génération d'identifiants à utiliser, avec le flux du compte de service, reportez-vous à la section Comptes de service .
Suivez la procédure pour configurer un projet dans la console Google APIs.
- Ouvrez la page Identifiants dans la console API.
Cliquez sur CRÉER DES IDENTIFIANTS > ID client OAuth.
Si vous n'aviez pas configuré d'écran de consentement OAuth pour ce projet auparavant, vous serez invité à le faire maintenant. Cliquez sur CONFIGURER L'AUTORISATION. ÉCRAN
Sélectionnez le type d'utilisateur, puis cliquez sur CRÉER.
Remplissez le formulaire initial. Vous pourrez le modifier plus tard si nécessaire. Cliquez sur Lorsque vous avez terminé, cliquez sur Enregistrer.
Revenez à la page Identifiants > CRÉER DES IDENTIFIANTS > ID client OAuth pour continuer.
Sélectionnez Application de bureau comme type d'application, donnez-lui un nom, puis cliquez sur Créer :
Lorsque vous aurez terminé, vous recevrez un ID client OAuth 2.0 et un client que vous pouvez télécharger au format JSON et enregistrer pour une utilisation ultérieure.
<ph type="x-smartling-placeholder">Installer une bibliothèque cliente
L'API Campaign Manager 360 étant basée sur HTTP et JSON, n'importe quel client HTTP standard peut envoyer et d'analyser les réponses.
Toutefois, les bibliothèques clientes des API Google offrent une meilleure intégration des langages une sécurité renforcée et la prise en charge de l’envoi de requêtes autorisées. Le client les bibliothèques sont disponibles dans un certain nombre de langages de programmation ; En les utilisant, vous vous n'avez pas besoin de configurer les requêtes HTTP ni d'analyser les réponses manuellement.
Pour commencer, sélectionnez le langage de programmation que vous utilisez développement d'applications.
C#
Installez la dernière bibliothèque cliente de l'API Campaign Manager 360 pour .NET. En utilisant Nous vous recommandons d'utiliser NuGet pour gérer votre installation.
Ouvrez la console du gestionnaire de packages NuGet et exécutez la commande suivante:
Install-Package Google.Apis.Dfareporting.v3_4
En savoir plus
Java
Installez la dernière bibliothèque cliente de l'API Campaign Manager 360 pour Java. En utilisant Nous vous recommandons d'utiliser Maven pour gérer votre installation.
Ajoutez la dépendance suivante à votre fichier pom.xml
:
<dependency> <groupId>com.google.apis</groupId> <artifactId>google-api-services-dfareporting</artifactId> <version>v4-rev20220611-1.32.1</version> <exclusions> <exclusion> <groupId>com.google.guava</groupId> <artifactId>guava-jdk5</artifactId> </exclusion> </exclusions> </dependency>
En savoir plus
PHP
Installez la dernière bibliothèque cliente de l'API Campaign Manager 360 pour PHP. En utilisant Nous vous recommandons d'utiliser Composer pour gérer votre installation.
Ouvrez un terminal et exécutez la commande suivante:
composer require google/apiclient
Si vous avez déjà installé la bibliothèque et souhaitez simplement effectuer la mise à jour vers dernière version:
composer update google/apiclient
Selon votre système, vous devrez peut-être ajouter un préfixe à ces commandes avec
sudo
En savoir plus
Python
Installez la dernière bibliothèque cliente de l'API Campaign Manager 360 pour Python. En utilisant Nous vous recommandons d'utiliser pip pour gérer votre installation.
Ouvrez un terminal et exécutez la commande suivante:
pip install --upgrade google-api-python-client
Selon votre système, vous devrez peut-être ajouter un préfixe à ces commandes avec
sudo
En savoir plus
Ruby
Installez la dernière bibliothèque cliente de l'API Campaign Manager 360 pour Ruby. En utilisant Nous vous recommandons d'utiliser RubyGems pour gérer votre installation.
Ouvrez un terminal et exécutez la commande suivante:
gem install google-api-client
Si vous avez déjà installé la bibliothèque et souhaitez simplement effectuer la mise à jour vers dernière version:
gem update -y google-api-client
Selon votre système, vous devrez peut-être ajouter un préfixe à ces commandes avec
sudo
En savoir plus
D'autres langages pris en charge sont disponibles sur la page Client Bibliothèques.
Envoyer une requête
Avec des identifiants OAuth 2.0 créés et une bibliothèque cliente , vous pouvez commencer à utiliser l'API Campaign Manager 360. En savoir plus autoriser, configurer votre client et effectuer votre première demande en suivant dans le guide de démarrage rapide ci-dessous.
C#
Chargez le fichier de codes secrets du client et générez des identifiants d'autorisation.
La première fois que vous effectuez cette étape, vous êtes invité à accepter une invite d'autorisation dans votre navigateur. Avant d'accepter, vérifiez que vous êtes connecté à un compte Google ayant accès à Campaign Manager 360. Votre application sera autorisée à accéder aux données au nom du compte actuellement connecté.
// 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;
Créez un client Dfareporting autorisé.
// 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" } );
Effectuez une opération.
// 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
Chargez le fichier de codes secrets du client et générez des identifiants d'autorisation.
La première fois que vous effectuez cette étape, vous êtes invité à accepter une invite d'autorisation dans votre navigateur. Avant d'accepter, vérifiez que vous êtes connecté à un compte Google ayant accès à Campaign Manager 360. Votre application sera autorisée à accéder aux données au nom du compte actuellement connecté.
// 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");
Créez un client Dfareporting autorisé.
// 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();
Effectuez une opération.
// 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
Chargez le fichier de codes secrets du client et générez des identifiants d'autorisation.
La première fois que vous effectuez cette étape, vous êtes invité à accepter une invite d'autorisation dans votre navigateur. Avant d'accepter, vérifiez que vous êtes connecté à un compte Google ayant accès à Campaign Manager 360. Votre application sera autorisée à accéder aux données au nom du compte actuellement connecté.
// 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())); }
Créez un client Dfareporting autorisé.
// Create a Dfareporting service object. $service = new Google_Service_Dfareporting($client);
Effectuez une opération.
// 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
Chargez le fichier de codes secrets du client et générez des identifiants d'autorisation.
La première fois que vous effectuez cette étape, vous êtes invité à accepter une invite d'autorisation dans votre navigateur. Avant d'accepter, vérifiez que vous êtes connecté à un compte Google ayant accès à Campaign Manager 360. Votre application sera autorisée à accéder aux données au nom du compte actuellement connecté.
# 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())
Créez un client Dfareporting autorisé.
# Construct a service object via the discovery service. service = discovery.build('dfareporting', 'v4', http=http)
Effectuez une opération.
# 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']))
Ruby
Chargez le fichier de codes secrets du client et générez des identifiants d'autorisation.
La première fois que vous effectuez cette étape, vous êtes invité à accepter une invite d'autorisation dans votre navigateur. Avant d'accepter, vérifiez que vous êtes connecté à un compte Google ayant accès à Campaign Manager 360. Votre application sera autorisée à accéder aux données au nom du compte actuellement connecté.
# 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
Créez un client Dfareporting autorisé.
# 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'
Effectuez une opération.
// 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); }
En savoir plus
Consultez la documentation de référence de l'API pour en savoir plus sur les services que l'API a à offrir. Chaque page d'informations sur les méthodes inclut une API intégrée Explorer, qui vous permet d'effectuer des requêtes de test directement depuis votre navigateur.
Consultez nos autres guides, qui couvrent des sujets avancés et fournissent des informations pour les tâches courantes.
Lorsque vous êtes prêt à commencer à écrire du code, n'hésitez pas à explorer notre vaste un ensemble d'exemples de code pouvant être modifié ; étendu à vos besoins.