Começar

A API Campaign Manager 360 oferece acesso programático às informações dos seus na sua conta do Campaign Manager 360. Ela é usada para criar e gerenciar campanhas e relatórios, assim como você faria com o Campaign Manager 360 e os serviços da Web do Criador de relatórios.

Este guia descreve como começar a usar a API Campaign Manager 360.

Pré-requisitos

Antes de usar a API Campaign Manager 360, há alguns pré-requisitos que você precisa satisfazer:

  1. Você precisa ter uma conta do Campaign Manager 360. Consulte Anunciantes/agências para informações de inscrição.

  2. Sua conta do Campaign Manager 360 precisa ter o acesso à API ativado. Mais frequentes em contas têm essa opção ativada por padrão. Se não tiver certeza, entre em contato com seu representante da conta ou o suporte do Campaign Manager 360 em nuvem para receber ajuda.

  3. Você precisa ter um perfil de usuário com acesso a essa conta. Tenha seu O administrador da conta do Campaign Manager 360 cria um perfil de usuário associado a esta conta.

  4. Verifique as permissões de perfil de usuário na interface do Campaign Manager 360. Esses controles o que o perfil de usuário pode acessar pela API. Não há APIs separadas permissões.

Criar um projeto

Para começar a usar a API Campaign Manager 360, primeiro você precisa criar ou selecione um projeto no Console de APIs do Google e ative a API. Usar este orienta você no processo e ativa a API Campaign Manager 360 automaticamente.

Gerar credenciais

Todas as solicitações feitas à API Campaign Manager 360 precisam ser autorizadas. Resumo visão geral da autorização, leia sobre como autorizar e identificar seus aplicativo ao Google.

As instruções a seguir orientam você no processo de criação de uma conta OAuth ID do cliente 2.0 para usar com o aplicativo instalado fluxo. Para instruções sobre como gerar credenciais para uso com o fluxo da conta de serviço, consulte a página Contas de serviço guia.

  1. Siga as etapas para configurar um projeto do Console de APIs do Google.

  2. Abra a página Credenciais no Console da API.
  3. Clique em CRIAR CREDENCIAIS > ID do cliente OAuth

    1. Se você não tiver configurado uma tela de permissão OAuth para o projeto anteriormente, você será instruído a fazer isso agora. Clique em CONFIGURAR CONSENTIMENTO TELA.

    2. Selecione o tipo de usuário e clique em CRIAR.

    3. Preencha o formulário inicial. É possível editar isso mais tarde, se necessário. Clique em Clique em Salvar quando terminar.

    4. Volte para Credenciais > CRIAR CREDENCIAIS > ID do cliente OAuth para continuar.

  4. Selecione App para computador como o tipo de aplicativo, dê um nome e clique em Criar.

Quando terminar, você receberá um ID do cliente OAuth 2.0 e que pode ser baixado no formato JSON e salvo para uso posterior.

Instalar uma biblioteca de cliente

A API Campaign Manager 360 é criada com base em HTTP e JSON. Portanto, qualquer cliente HTTP padrão pode enviar solicitações para ele e analisar as respostas.

No entanto, as bibliotecas de cliente da API do Google proporcionam uma integração de linguagens melhor, melhor segurança e suporte para fazer solicitações autorizadas. O cliente estão disponíveis em várias linguagens de programação; ao usá-los, você pode evitar a necessidade de configurar manualmente solicitações HTTP e analisar as respostas.

Para começar, selecione a linguagem de programação que você está usando para no desenvolvimento de software.

C#

Instale a versão mais recente da biblioteca de cliente da API Campaign Manager 360 para .NET. Usando O NuGet (em inglês) para gerenciar a instalação é recomendado.

Abra o NuGet Package Manager Console e execute o seguinte comando:

Install-Package Google.Apis.Dfareporting.v3_4

Saiba mais

Java

Instale a versão mais recente da biblioteca de cliente da API Campaign Manager 360 para Java. Usando É recomendável usar o Maven para gerenciar a instalação.

Adicione a dependência abaixo ao arquivo 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>

Saiba mais

PHP

Instale a versão mais recente da biblioteca de cliente da API Campaign Manager 360 para PHP. Usando O Composer (em inglês) para gerenciar a instalação é recomendado.

Abra um terminal e execute o seguinte comando:

composer require google/apiclient

Se você já instalou a biblioteca e quer apenas atualizar para a versão mais recente:

composer update google/apiclient

Dependendo do sistema, talvez seja necessário anexar esses comandos ao início sudo:

Saiba mais

Python

Instale a versão mais recente da biblioteca de cliente da API Campaign Manager 360 para Python. Usando pip para gerenciar a instalação.

Abra um terminal e execute o seguinte comando:

pip install --upgrade google-api-python-client

Dependendo do sistema, talvez seja necessário anexar esses comandos ao início sudo:

Saiba mais

Ruby

Instale a versão mais recente da biblioteca de cliente da API Campaign Manager 360 para Ruby. Usando Recomendamos o RubyGems para gerenciar a instalação.

Abra um terminal e execute o seguinte comando:

gem install google-api-client

Se você já instalou a biblioteca e quer apenas atualizar para a versão mais recente:

gem update -y google-api-client

Dependendo do sistema, talvez seja necessário anexar esses comandos ao início sudo:

Saiba mais

Mais idiomas com suporte podem ser encontrados na página Cliente Bibliotecas.

Fazer uma solicitação

Com as credenciais do OAuth 2.0 criadas e uma biblioteca de cliente instalada, já pode começar a usar a API Campaign Manager 360. Saiba como para autorizar, configurar o cliente e fazer a primeira solicitação seguindo no guia de início rápido abaixo.

C#

  1. Carregue o arquivo da chave secreta do cliente e gere credenciais de autorização.

    Ao realizar essa etapa pela primeira vez, será solicitado que você aceite um prompt de autorização no navegador. Antes de aceitar, verifique se você fez login com uma Conta do Google que tenha acesso ao Campaign Manager 360. Seu aplicativo será autorizado a acessar dados em nome de qualquer conta que esteja conectada no 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;
    
  2. Criar um cliente 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"
        }
    );
    
  3. Execute uma operação.

    // 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

  1. Carregue o arquivo da chave secreta do cliente e gere credenciais de autorização.

    Ao realizar essa etapa pela primeira vez, será solicitado que você aceite um prompt de autorização no navegador. Antes de aceitar, verifique se você fez login com uma Conta do Google que tenha acesso ao Campaign Manager 360. Seu aplicativo será autorizado a acessar dados em nome de qualquer conta que esteja conectada no 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");
    
  2. Criar um cliente 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();
    
  3. Execute uma operação.

    // 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

  1. Carregue o arquivo da chave secreta do cliente e gere credenciais de autorização.

    Ao realizar essa etapa pela primeira vez, será solicitado que você aceite um prompt de autorização no navegador. Antes de aceitar, verifique se você fez login com uma Conta do Google que tenha acesso ao Campaign Manager 360. Seu aplicativo será autorizado a acessar dados em nome de qualquer conta que esteja conectada no 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()));
    }
    
  2. Criar um cliente Dfareporting autorizado.

    // Create a Dfareporting service object.
    $service = new Google_Service_Dfareporting($client);
    
  3. Execute uma operação.

    // 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

  1. Carregue o arquivo da chave secreta do cliente e gere credenciais de autorização.

    Ao realizar essa etapa pela primeira vez, será solicitado que você aceite um prompt de autorização no navegador. Antes de aceitar, verifique se você fez login com uma Conta do Google que tenha acesso ao Campaign Manager 360. Seu aplicativo será autorizado a acessar dados em nome de qualquer conta que esteja conectada no 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())
    
  2. Criar um cliente Dfareporting autorizado.

    # Construct a service object via the discovery service.
    service = discovery.build('dfareporting', 'v4', http=http)
    
  3. Execute uma operação.

    # 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

  1. Carregue o arquivo da chave secreta do cliente e gere credenciais de autorização.

    Ao realizar essa etapa pela primeira vez, será solicitado que você aceite um prompt de autorização no navegador. Antes de aceitar, verifique se você fez login com uma Conta do Google que tenha acesso ao Campaign Manager 360. Seu aplicativo será autorizado a acessar dados em nome de qualquer conta que esteja conectada no 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
    
  2. Criar um cliente 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'
    
  3. Execute uma operação.

    // 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);
    }
    

Saiba mais

Acesse a Referência da API para saber mais sobre todos os serviços dos tem a oferecer. Todas as páginas de detalhes dos métodos têm uma API incorporada Explorer para fazer solicitações de teste diretamente navegador.

Consulte nossos outros guias que abordam tópicos avançados e oferecem exemplos de tarefas comuns.

Quando estiver pronto para começar a escrever códigos, sinta-se à vontade para explorar nossos extensos coleção de amostras de código, que pode ser modificada e ou estendidos para atender às suas necessidades.