La API de Campaign Manager 360 brinda acceso programático a la información de tu de Campaign Manager 360. Se usa para administrar y crear informes y campañas. tal como lo harías con los servicios web de Campaign Manager 360 y el Creador de informes.
En esta guía, se describe cómo comenzar a usar la API de Campaign Manager 360.
Requisitos previos
Antes de usar la API de Campaign Manager 360, debes cumplir con algunos requisitos previos: satisfacer:
Debes tener una cuenta de Campaign Manager 360. Consulta Anunciantes o agencias para obtener información sobre el registro.
Tu cuenta de Campaign Manager 360 debe tener habilitado el acceso a la API. Más probable las cuentas tienen esta opción habilitada de forma predeterminada; Si no lo sabes con certeza, comunícate con tu representante de cuenta o al equipo de asistencia de Campaign Manager 360 equipo para recibir asistencia.
Debes tener un perfil de usuario con acceso a esta cuenta. Tenga su el administrador de cuentas de Campaign Manager 360 crea un perfil de usuario asociado esta cuenta.
Verifica los permisos del perfil del usuario en la IU de Campaign Manager 360. Estos controles a qué puede acceder el perfil de usuario desde la API. No hay APIs separadas permisos.
Crea un proyecto
Para comenzar a usar la API de Campaign Manager 360, primero debes crear o selecciona un proyecto en la Consola de APIs de Google y habilita la API. Uso El vínculo lo guía en el proceso y activa la API de Campaign Manager 360. automáticamente.
Genera credenciales
Todas las solicitudes que realices a la API de Campaign Manager 360 deben estar autorizadas. Para un resumen descripción general de la autorización, lea sobre cómo autorizar e identificar su aplicación a Google.
Las siguientes instrucciones te guiarán a través del proceso de creación de un OAuth ID de cliente 2.0 para usar con la aplicación instalada de Terraform. Para obtener instrucciones sobre cómo generar credenciales para usar con el flujo de cuentas de servicio, consulta Cuentas de servicio .
Sigue los pasos para configurar un proyecto de la Consola de APIs de Google.
- Abre la página Credenciales en la Consola de APIs.
Haz clic en CREAR CREDENCIALES > ID de cliente de OAuth.
Si no habías configurado una pantalla de consentimiento de OAuth para este proyecto anteriormente, se te indicará que lo hagas ahora. Haz clic en CONFIGURAR CONSENTIMIENTO. PANTALLA.
Selecciona el tipo de usuario y haz clic en CREAR.
Completa el formulario inicial. Puedes editarla más tarde si es necesario. Haz clic en Guardar cuando termines.
Regresa a Credenciales > CREAR CREDENCIALES > ID de cliente de OAuth para continuar.
Selecciona Aplicación de escritorio como el tipo de aplicación, asígnale un nombre y haz clic en Crear.
Cuando hayas terminado, podrás ver el ID de cliente de OAuth 2.0 y el cliente. que puedes descargar en formato JSON y guardarlo para usarlo más tarde.
Instala una biblioteca cliente
La API de Campaign Manager 360 se basa en HTTP y JSON, por lo que cualquier cliente HTTP estándar puede enviar y analizar las respuestas.
Sin embargo, las bibliotecas cliente de la API de Google ofrecen una mejor integración de lenguajes, mayor seguridad y asistencia para realizar solicitudes autorizadas. El cliente las bibliotecas están disponibles en varios lenguajes de programación: al usarlos, puedes evitar tener que configurar manualmente solicitudes HTTP y analizar las respuestas.
Para comenzar, selecciona el lenguaje de programación que usas en el desarrollo de software.
C#
Instala la biblioteca cliente de la API de Campaign Manager 360 para .NET más reciente. Usando Se recomienda usar NuGet para administrar la instalación.
Abre la consola del administrador de paquetes de NuGet y ejecuta el siguiente comando:
Install-Package Google.Apis.Dfareporting.v3_4
Más información
Java
Instala la biblioteca cliente de la API de Campaign Manager 360 para Java más reciente. Usando Se recomienda usar Maven para administrar la instalación.
Agrega la siguiente dependencia a tu archivo 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>
Más información
PHP
Instala la biblioteca cliente de la API de Campaign Manager 360 para PHP más reciente. Usando Se recomienda usar Composer para administrar la instalación.
Abre una terminal y ejecuta el siguiente comando:
composer require google/apiclient
Si ya instalaste la biblioteca y solo quieres actualizar a la versión más reciente:
composer update google/apiclient
Según tu sistema, es posible que debas anteponer estos comandos con
sudo
Más información
Python
Instala la biblioteca cliente de la API de Campaign Manager 360 para Python más reciente. Usando Se recomienda usar pip para administrar la instalación.
Abre una terminal y ejecuta el siguiente comando:
pip install --upgrade google-api-python-client
Según tu sistema, es posible que debas anteponer estos comandos con
sudo
Más información
Rita
Instala la biblioteca cliente de la API de Campaign Manager 360 para Ruby más reciente. Usando Se recomienda usar RubyGems para administrar tu instalación.
Abre una terminal y ejecuta el siguiente comando:
gem install google-api-client
Si ya instalaste la biblioteca y solo quieres actualizar a la versión más reciente:
gem update -y google-api-client
Según tu sistema, es posible que debas anteponer estos comandos con
sudo
Más información
Puedes encontrar más idiomas compatibles en la pestaña Client Bibliotecas.
Haz una solicitud
Con credenciales de OAuth 2.0 creadas y una biblioteca cliente instalada, ya puedes comenzar a usar la API de Campaign Manager 360. Más información para autorizar, configurar el cliente y hacer tu primera solicitud siguiendo la siguiente guía de inicio rápido.
C#
Carga el archivo de secretos del cliente y genera credenciales de autorización.
La primera vez que realices este paso, se te pedirá que aceptes una solicitud de autorización en tu navegador. Antes de aceptar, asegúrate de haber accedido con una Cuenta de Google que tenga acceso a Campaign Manager 360. Tu aplicación estará autorizada para acceder a los datos en nombre de cualquier cuenta a la que se haya accedido en ese momento.
// 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;
Crea un cliente de Dfareporting autorizado.
// 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" } );
Realiza una operación.
// 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
Carga el archivo de secretos del cliente y genera credenciales de autorización.
La primera vez que realices este paso, se te pedirá que aceptes una solicitud de autorización en tu navegador. Antes de aceptar, asegúrate de haber accedido con una Cuenta de Google que tenga acceso a Campaign Manager 360. Tu aplicación estará autorizada para acceder a los datos en nombre de cualquier cuenta a la que se haya accedido en ese momento.
// 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");
Crea un cliente de Dfareporting autorizado.
// 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();
Realiza una operación.
// 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
Carga el archivo de secretos del cliente y genera credenciales de autorización.
La primera vez que realices este paso, se te pedirá que aceptes una solicitud de autorización en tu navegador. Antes de aceptar, asegúrate de haber accedido con una Cuenta de Google que tenga acceso a Campaign Manager 360. Tu aplicación estará autorizada para acceder a los datos en nombre de cualquier cuenta a la que se haya accedido en ese momento.
// 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())); }
Crea un cliente de Dfareporting autorizado.
// Create a Dfareporting service object. $service = new Google_Service_Dfareporting($client);
Realiza una operación.
// 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
Carga el archivo de secretos del cliente y genera credenciales de autorización.
La primera vez que realices este paso, se te pedirá que aceptes una solicitud de autorización en tu navegador. Antes de aceptar, asegúrate de haber accedido con una Cuenta de Google que tenga acceso a Campaign Manager 360. Tu aplicación estará autorizada para acceder a los datos en nombre de cualquier cuenta a la que se haya accedido en ese momento.
# 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())
Crea un cliente de Dfareporting autorizado.
# Construct a service object via the discovery service. service = discovery.build('dfareporting', 'v4', http=http)
Realiza una operación.
# 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']))
Rita
Carga el archivo de secretos del cliente y genera credenciales de autorización.
La primera vez que realices este paso, se te pedirá que aceptes una solicitud de autorización en tu navegador. Antes de aceptar, asegúrate de haber accedido con una Cuenta de Google que tenga acceso a Campaign Manager 360. Tu aplicación estará autorizada para acceder a los datos en nombre de cualquier cuenta a la que se haya accedido en ese momento.
# 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
Crea un cliente de Dfareporting autorizado.
# 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'
Realiza una operación.
// 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); }
Más información
Consulta la Referencia de la API para obtener más información sobre todos los servicios que la API tiene para ofrecer. La página de detalles de cada método tiene una API incorporada Explorer, que puedes usar para realizar solicitudes de prueba directamente desde tu navegador.
Consulta nuestras otras guías, que incluyen temas avanzados y ofrecen orientación integral ejemplos de tareas comunes.
Cuando esté todo listo para comenzar a escribir código, puedes explorar nuestro amplio una colección de muestras de código que pueden modificarse y ampliadas para adaptarlas a tus necesidades.