Rozpocznij

Interfejs API Campaign Managera 360 zapewnia automatyczny dostęp do informacji Campaign Manager 360. Służy do tworzenia kampanii i raportów oraz zarządzania nimi, tak samo jak w usługach internetowych 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 wymagań wstępnych: satysfakcjonujące:

  1. Musisz mieć konto w usłudze Campaign Manager 360. Zobacz Reklamodawcy lub agencje – informacje dotyczące rejestracji.

  2. Na swoim koncie w usłudze Campaign Manager 360 musisz włączyć dostęp do interfejsu API. Większość ta funkcja jest domyślnie włączona na kontach, w razie wątpliwości skontaktuj się ze swoim opiekun klienta lub zespół pomocy Campaign Managera 360 .

  3. Musisz mieć profil użytkownika z dostępem do tego konta. Upewnij się, że Administrator konta w usłudze Campaign Manager 360 utworzył profil użytkownika powiązany z to konto.

  4. Sprawdź uprawnienia profilu użytkownika w interfejsie Campaign Managera 360. Te elementy sterujące do jakich danych profil użytkownika ma dostęp z interfejsu API. Nie ma oddzielnego interfejsu API uprawnień.

Utwórz projekt

Aby zacząć korzystać z interfejsu Campaign Manager 360 API, musisz najpierw utworzyć lub wybierz projekt w Konsoli interfejsów API Google i włącz interfejs API. Użycie tego przeprowadzi Cię przez cały proces i aktywuje interfejs Campaign Manager 360 API. automatycznie.

Wygeneruj dane logowania

Wszystkie żądania wysyłane do interfejsu Campaign Manager 360 API muszą być autoryzowane. Krótkie omówienie omówienie procesu autoryzacji, dowiedz się, jak autoryzować i identyfikować do Google.

Poniżej znajdziesz instrukcje tworzenia protokołu OAuth Identyfikator klienta 2.0 do użycia z zainstalowaną aplikacją . Instrukcje generowania danych logowania do użytku z procesem logowania na konto usługi, zapoznaj się z sekcją Konta usługi. Google.

  1. Postępuj zgodnie z instrukcjami, aby skonfigurować projekt w Konsoli interfejsów API Google.

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

    1. Jeśli w tym projekcie nie masz skonfigurowanego ekranu zgody OAuth musisz zrobić to teraz. Kliknij SKONFIGURUJ ZGODĘ EKRAN.

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

    3. Wypełnij początkowy formularz. W razie potrzeby możesz go później zmienić. Kliknij Gdy skończysz, Zapisz.

    4. Wróć do sekcji Dane logowania > UTWÓRZ DANE LOGOWANIA > Identyfikator klienta OAuth w kontynuuj.

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

Gdy skończysz, zobaczysz identyfikator i klienta OAuth 2.0 obiekt tajny, który możesz pobrać w formacie JSON i zapisać do późniejszego użycia.

Instalowanie biblioteki klienta

Interfejs API Campaign Managera 360 opiera się na protokole HTTP i JSON, więc każdy standardowy klient HTTP może wysyłać i analizować odpowiedzi.

Biblioteki klienta interfejsów API Google zapewniają jednak lepszą integrację językową, lepsze zabezpieczenia i obsługę wysyłania autoryzowanych żądań. Klient biblioteki są dostępne w wielu językach programowania; pozwala uniknąć konieczności ręcznego konfigurowania żądań HTTP i analizowania odpowiedzi.

Najpierw wybierz język programowania, którego używasz. w Google Cloud.

C#

Zainstaluj najnowszą bibliotekę klienta interfejsu API Campaign Managera 360 dla języka .NET. Zastosowanie Do zarządzania instalacją zalecamy NuGet.

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 dla języka Java. Zastosowanie Do zarządzania instalacją zalecamy Maven.

Dodaj tę zależność do pliku 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>

Więcej informacji

PHP

Zainstaluj najnowszą bibliotekę klienta interfejsu Campaign Manager 360 API na potrzeby języka PHP. Zastosowanie Do zarządzania instalacją zalecamy narzędzie Composer.

Otwórz terminal i uruchom to polecenie:

composer require google/apiclient

Jeśli masz już zainstalowaną bibliotekę i chcesz tylko zaktualizować najnowsza wersja:

composer update google/apiclient

W zależności od systemu konieczne może być dodanie do tych poleceń przedrostka sudo

Więcej informacji

Python

Zainstaluj najnowszą bibliotekę klienta interfejsu Campaign Manager 360 API dla języka Python. Zastosowanie Zalecamy użyć polecenia pip do zarządzania instalacją.

Otwórz terminal i uruchom to polecenie:

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

W zależności od systemu konieczne może być dodanie do tych poleceń przedrostka sudo

Więcej informacji

Ruby

Zainstaluj najnowszą bibliotekę klienta interfejsu Campaign Manager 360 API dla języka Ruby. Zastosowanie Do zarządzania instalacją zalecamy aplikację RubyGems.

Otwórz terminal i uruchom to polecenie:

gem install google-api-client

Jeśli masz już zainstalowaną bibliotekę i chcesz tylko zaktualizować najnowsza wersja:

gem update -y google-api-client

W zależności od systemu konieczne może być dodanie do tych poleceń przedrostka sudo

Więcej informacji

Więcej obsługiwanych języków można znaleźć w Klientie Strona Biblioteki.

Poproś

Utworzenie danych logowania OAuth 2.0 i bibliotekę klienta , możesz zacząć korzystać z interfejsu Campaign Manager 360 API. Dowiedz się, jak to zrobić aby autoryzować, skonfigurować klienta i wysłać pierwsze żądanie, wykonując znajdziesz w krótkim wprowadzeniu poniżej.

C#

  1. Wczytaj plik z tajnymi kluczami klienta i wygeneruj dane uwierzytelniające.

    Gdy wykonasz ten krok po raz pierwszy, poprosimy Cię o zaakceptowanie prośby o autoryzację w przeglądarce. Zanim zaakceptujesz, upewnij się, że korzystasz z konta Google, które ma dostęp do Campaign Managera 360. Aplikacja uzyska dostęp do danych w imieniu konta, na którym jest obecnie 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 z tajnymi kluczami klienta i wygeneruj dane uwierzytelniające.

    Gdy wykonasz ten krok po raz pierwszy, poprosimy Cię o zaakceptowanie prośby o autoryzację w przeglądarce. Zanim zaakceptujesz, upewnij się, że korzystasz z konta Google, które ma dostęp do Campaign Managera 360. Aplikacja uzyska dostęp do danych w imieniu konta, na którym jest obecnie 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 z tajnymi kluczami klienta i wygeneruj dane uwierzytelniające.

    Gdy wykonasz ten krok po raz pierwszy, poprosimy Cię o zaakceptowanie prośby o autoryzację w przeglądarce. Zanim zaakceptujesz, upewnij się, że korzystasz z konta Google, które ma dostęp do Campaign Managera 360. Aplikacja uzyska dostęp do danych w imieniu konta, na którym jest obecnie 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 z tajnymi kluczami klienta i wygeneruj dane uwierzytelniające.

    Gdy wykonasz ten krok po raz pierwszy, poprosimy Cię o zaakceptowanie prośby o autoryzację w przeglądarce. Zanim zaakceptujesz, upewnij się, że korzystasz z konta Google, które ma dostęp do Campaign Managera 360. Aplikacja uzyska dostęp do danych w imieniu konta, na którym jest obecnie 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 z tajnymi kluczami klienta i wygeneruj dane uwierzytelniające.

    Gdy wykonasz ten krok po raz pierwszy, poprosimy Cię o zaakceptowanie prośby o autoryzację w przeglądarce. Zanim zaakceptujesz, upewnij się, że korzystasz z konta Google, które ma dostęp do Campaign Managera 360. Aplikacja uzyska dostęp do danych w imieniu konta, na którym jest obecnie 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 powiązanych z interfejsem API znajdziesz w materiałach referencyjnych interfejsu API. API ma do zaoferowania. Każda strona ze szczegółami metody ma osadzony interfejs API Eksploratora, za pomocą którego możesz wysyłać żądania testowe bezpośrednio z poziomu przeglądarki przeglądarki.

Przejrzyj nasze inne przewodniki obejmujące zaawansowane tematy i dostarczające kompleksowe na przykład do typowych zadań.

Jeśli chcesz zacząć pisać kod, zapoznaj się z naszą rozbudowaną przykładowego kodu, który można modyfikować do Twoich potrzeb.