Pierwsze kroki

Interfejs Campaign Manager 360 API zapewnia automatyczny dostęp do informacji z Twojego konta w tej usłudze. Służy on do tworzenia kampanii i raportów oraz zarządzania nimi tak samo jak usługi internetowe Campaign Managera 360 i Kreatora raportów.

Z tego przewodnika dowiesz się, jak zacząć korzystać z interfejsu Campaign Manager 360 API.

Wymagania wstępne

Zanim zaczniesz korzystać z interfejsu Campaign Manager 360 API, musisz spełnić kilka warunków:

  1. Musisz mieć konto w usłudze Campaign Manager 360. Więcej informacji znajdziesz w artykule Reklamodawcy/agencje reklamowe.

  2. Na koncie Campaign Managera 360 musisz włączyć dostęp do interfejsu API. Jest ona domyślnie włączona na większości kont. Jeśli nie masz pewności, skontaktuj się ze swoim opiekunem klienta lub zespołem pomocy Campaign Managera 360.

  3. Musisz mieć profil użytkownika z dostępem do tego konta. Poproś administratora konta Campaign Managera 360 o utworzenie profilu użytkownika powiązanego z tym kontem.

  4. Sprawdź uprawnienia profilu użytkownika w interfejsie Campaign Managera 360 Od tych ustawień zależy dostęp użytkowników do profilu. Nie ma oddzielnych uprawnień do interfejsu API.

Utwórz projekt

Aby zacząć korzystać z interfejsu Campaign Manager 360 API, musisz najpierw utworzyć lub wybrać projekt w konsoli interfejsów API Google i włączyć ten interfejs. Ten link prowadzi przez cały proces i automatycznie aktywuje interfejs Campaign Manager 360 API.

Wygeneruj dane logowania

Wszystkie żądania wysyłane do interfejsu Campaign Manager 360 API muszą być autoryzowane. Więcej informacji o autoryzacji znajdziesz w artykule o autoryzowaniu i identyfikowaniu aplikacji w Google.

Poniżej znajdziesz instrukcje tworzenia identyfikatora klienta OAuth 2.0 do wykorzystania w zainstalowanym procesie aplikacji. Instrukcje generowania danych logowania do wykorzystania z kontem usługi znajdziesz w przewodniku Konta usługi.

  1. Postępuj zgodnie z instrukcjami konfigurowania projektu w Konsoli interfejsów API Google.

  2. Otwórz stronę Dane logowania w konsoli interfejsów API.
  3. Kliknij UTWÓRZ KWALIFIKACJE > Identyfikator klienta OAuth.

    1. Jeśli w tym projekcie nie masz jeszcze skonfigurowanego ekranu zgody OAuth, zobaczysz prośbę, aby to zrobić. Kliknij SKONFIGURUJ EKRAN ZGODY.

    2. Wybierz typ użytkownika i kliknij UTWÓRZ.

    3. Wypełnij wstępny formularz. W razie potrzeby możesz je później zmienić. Gdy skończysz, kliknij Zapisz.

    4. Aby kontynuować, wróć do sekcji Dane logowania > UTWÓRZ KWALIFIKACJE > Identyfikator klienta OAuth.

  4. Jako typ aplikacji wybierz Aplikacja komputerowa, nadaj jej nazwę, a potem kliknij Utwórz.

Po zakończeniu wyświetli się identyfikator klienta OAuth 2.0 i tajny klucz klienta, które możesz pobrać w formacie JSON i zapisać do późniejszego użycia.

Instalowanie biblioteki klienta

Interfejs Campaign Manager 360 API jest oparty na HTTP i JSON, więc każdy standardowy klient HTTP może wysyłać do niego żądania i analizować odpowiedzi.

Biblioteki klienta interfejsu API Google zapewniają jednak lepszą integrację języka, wyższy poziom bezpieczeństwa i obsługę żądań autoryzowanych. Biblioteki klienta są dostępne w wielu językach programowania. Dzięki nim nie musisz ręcznie konfigurować żądań HTTP ani analizować odpowiedzi.

Na początek wybierz język programowania, którego używasz na potrzeby programowania.

C#

Zainstaluj najnowszą bibliotekę klienta interfejsu Campaign Manager 360 API dla domeny .NET. Zalecamy korzystanie z NuGet do zarządzania instalacją.

Otwórz konsolę menedżera pakietów NuGet i uruchom to polecenie:

Install-Package Google.Apis.Dfareporting.v3_4

Więcej informacji

Java

Zainstaluj najnowszą bibliotekę klienta interfejsu Campaign Manager 360 API na potrzeby języka Java. Do zarządzania instalacją zalecamy użycie narzędzia Maven.

Dodaj do pliku pom.xml te zależności:

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

Więcej informacji

PHP

Zainstaluj najnowszą bibliotekę klienta interfejsu Campaign Manager 360 API dla języka PHP. Do zarządzania instalacją zalecamy użycie narzędzia Composer.

Otwórz terminal i uruchom to polecenie:

composer require google/apiclient

Jeśli biblioteka jest już zainstalowana i chcesz tylko zaktualizować ją do najnowszej wersji:

composer update google/apiclient

W zależności od używanego systemu może być konieczne dodanie do polecenia sudo na początku tego polecenia.

Więcej informacji

Python

Zainstaluj najnowszą bibliotekę klienta interfejsu Campaign Manager 360 API dla Pythona. Do zarządzania instalacją zalecamy użycie pip.

Otwórz terminal i uruchom to polecenie:

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

W zależności od używanego systemu może być konieczne dodanie do polecenia sudo na początku tego polecenia.

Więcej informacji

Ruby

Zainstaluj najnowszą bibliotekę klienta interfejsu Campaign Manager 360 API dla systemu Ruby. Do zarządzania instalacją zalecamy korzystanie z RubyGems.

Otwórz terminal i uruchom to polecenie:

gem install google-api-client

Jeśli biblioteka jest już zainstalowana i chcesz tylko zaktualizować ją do najnowszej wersji:

gem update -y google-api-client

W zależności od używanego systemu może być konieczne dodanie do polecenia sudo na początku tego polecenia.

Więcej informacji

Więcej obsługiwanych języków znajdziesz na stronie Biblioteki klienta.

Poproś

Po utworzeniu danych logowania OAuth 2.0 i zainstalowaniu biblioteki klienta możesz zacząć korzystać z interfejsu API Campaign Managera 360. Dowiedz się, jak autoryzować, konfigurować klienta i wysyłać pierwsze żądanie. Wystarczy, że skorzystasz z krótkiego wprowadzenia poniżej.

C#

  1. Wczytaj plik tajnych kluczy klienta i wygeneruj dane logowania.

    Gdy pierwszy raz wykonasz ten krok, w przeglądarce pojawi się prośba o zaakceptowanie zaproszenia. Zanim to zrobisz, upewnij się, że używasz tego konta Google, które ma dostęp do Campaign Managera 360. Twoja aplikacja zostanie upoważniona do uzyskiwania dostępu do danych w imieniu konta, na które jesteś zalogowany(-a)

    // 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. Utwórz autoryzowanego klienta 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"
        }
    );
    
  3. Wykonaj operację.

    // 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. Wczytaj plik tajnych kluczy klienta i wygeneruj dane logowania.

    Gdy pierwszy raz wykonasz ten krok, w przeglądarce pojawi się prośba o zaakceptowanie zaproszenia. Zanim to zrobisz, upewnij się, że używasz tego konta Google, które ma dostęp do Campaign Managera 360. Twoja aplikacja zostanie upoważniona do uzyskiwania dostępu do danych w imieniu konta, na które jesteś zalogowany(-a)

    // 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. Utwórz autoryzowanego klienta 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();
    
  3. Wykonaj operację.

    // 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. Wczytaj plik tajnych kluczy klienta i wygeneruj dane logowania.

    Gdy pierwszy raz wykonasz ten krok, w przeglądarce pojawi się prośba o zaakceptowanie zaproszenia. Zanim to zrobisz, upewnij się, że używasz tego konta Google, które ma dostęp do Campaign Managera 360. Twoja aplikacja zostanie upoważniona do uzyskiwania dostępu do danych w imieniu konta, na które jesteś zalogowany(-a)

    // 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. Utwórz autoryzowanego klienta Dfareporting.

    // Create a Dfareporting service object.
    $service = new Google_Service_Dfareporting($client);
    
  3. Wykonaj operację.

    // 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. Wczytaj plik tajnych kluczy klienta i wygeneruj dane logowania.

    Gdy pierwszy raz wykonasz ten krok, w przeglądarce pojawi się prośba o zaakceptowanie zaproszenia. Zanim to zrobisz, upewnij się, że używasz tego konta Google, które ma dostęp do Campaign Managera 360. Twoja aplikacja zostanie upoważniona do uzyskiwania dostępu do danych w imieniu konta, na które jesteś zalogowany(-a)

    # 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. Utwórz autoryzowanego klienta Dfareporting.

    # Construct a service object via the discovery service.
    service = discovery.build('dfareporting', 'v4', http=http)
    
  3. Wykonaj operację.

    # 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. Wczytaj plik tajnych kluczy klienta i wygeneruj dane logowania.

    Gdy pierwszy raz wykonasz ten krok, w przeglądarce pojawi się prośba o zaakceptowanie zaproszenia. Zanim to zrobisz, upewnij się, że używasz tego konta Google, które ma dostęp do Campaign Managera 360. Twoja aplikacja zostanie upoważniona do uzyskiwania dostępu do danych w imieniu konta, na które jesteś zalogowany(-a)

    # 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. Utwórz autoryzowanego klienta 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'
    
  3. Wykonaj operację.

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

Więcej informacji

Więcej informacji o wszystkich usługach dostępnych w tym interfejsie znajdziesz w dokumentacji. Każda strona ze szczegółami metody ma umieszczony eksplorator interfejsu API, którego możesz używać do wysyłania żądań testowych bezpośrednio z przeglądarki.

Przejrzyj nasze inne przewodniki, w których znajdziesz omówienie zaawansowanych zagadnień i pełne przykłady typowych zadań.

Jeśli chcesz zacząć tworzyć kod, skorzystaj z naszej obszernej kolekcji kodów, które możesz dostosowywać i dostosowywać do swoich potrzeb.