使ってみる

Campaign Manager 360 API を使用すると、 キャンペーン マネージャー 360 アカウント。キャンペーンとレポートの管理と作成、 これはキャンペーン マネージャー 360 とレポート ビルダーのウェブサービスで行う場合とまったく同じです。

このガイドでは、Campaign Manager 360 API の使用方法について説明します。

前提条件

Campaign Manager 360 API を使用するには、いくつかの操作を事前に行う必要があります。 満足:

  1. キャンペーン マネージャー 360 のアカウントが必要です。詳しくは、 広告主/代理店: 登録情報

  2. キャンペーン マネージャー 360 アカウントで API アクセスを有効にする必要があります。ほとんど デフォルトで有効になっていますが、不明な場合は、 アカウント担当者またはキャンペーン マネージャー 360 サポートまでお問い合わせください チームにお問い合わせください。

  3. このアカウントへのアクセス権を持つユーザー プロフィールが必要です。お客様の キャンペーン マネージャー 360 アカウント管理者は、 表示されます。

  4. キャンペーン マネージャー 360 の管理画面でユーザー プロフィールの権限を確認します。これらのコントロール API からアクセスできるものを指定します。個別の API は 付与できます。

プロジェクトを作成する

Campaign Manager 360 API を使用するには、まず または、Google API Console でプロジェクトを選択して、API を有効にします。こちらの リンクをクリックすると、手順に沿って操作し、Campaign Manager 360 API が有効になります 自動的に適用されます。

<ph type="x-smartling-placeholder">

認証情報を生成する

Campaign Manager 360 API に対するリクエストはすべて、認証を受ける必要があります。概要 認可の概要については、 Google に提供します。

以下では、OAuth 2.0 API を作成するプロセスについて説明します。 インストール済みアプリケーションで使用する 2.0 クライアント ID フローで参照できます。使用する認証情報の生成手順については、 手順については、サービス アカウントをご覧ください。 ご覧ください

  1. 手順に沿って Google API Console プロジェクトを設定します。

  2. API コンソールで [認証情報] ページを開きます。

  3. [認証情報を作成 >OAuth クライアント ID。

    1. このプロジェクトで OAuth 同意画面を構成していない場合 今から行うように求められます。[同意を設定] をクリックします SCREEN。

    2. ユーザータイプを選択し、[作成] をクリックします。

    3. 最初のフォームに入力します。これは、必要に応じて後で編集できます。[ 完了したら [保存] をクリックします。

    4. [認証情報] >認証情報を作成 >OAuth クライアント ID を登録して、 続行します。

  4. アプリケーションの種類として [デスクトップ アプリ] を選択し、名前を指定してクリックします。 作成:

完了すると、OAuth 2.0 のクライアント ID とクライアントが表示されます。 JSON 形式でダウンロードして、後で使用できるように保存できます。

<ph type="x-smartling-placeholder">

クライアント ライブラリをインストールする

Campaign Manager 360 API は HTTP と JSON を基に構築されているため、標準の HTTP クライアントであれば、 レスポンスを解析します。

ただし、Google API クライアント ライブラリを使用すると、より優れた言語統合が可能になり、 セキュリティの向上、承認済みリクエストの作成のサポートが提供されます。クライアント さまざまなプログラミング言語で用意されています。使用することで、 HTTP リクエストを手動で設定してレスポンスを解析する必要がなくなります。

まず、お使いのプログラミング言語を選択してから、 必要があります。

C#

最新の .NET 用キャンペーン マネージャー 360 API クライアント ライブラリをインストールします。使用 インストールを管理する NuGet をおすすめします。

NuGet パッケージ マネージャー コンソールを開き、次のコマンドを実行します。

Install-Package Google.Apis.Dfareporting.v3_4

詳細

Java

最新の Java 向けキャンペーン マネージャー 360 API クライアント ライブラリをインストールします。使用 インストールを管理するための Maven をおすすめします。

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>

詳細

PHP

最新の PHP 向けキャンペーン マネージャー 360 API クライアント ライブラリをインストールします。使用 インストールを管理する Composer をおすすめします。

ターミナルを開いて、次のコマンドを実行します。

composer require google/apiclient

インストール済みのライブラリを 最新バージョン：

composer update google/apiclient

システムによっては、コマンドの前に sudo。

詳細

Python

最新の Python 用キャンペーン マネージャー 360 API クライアント ライブラリをインストールします。使用 pip を使用してインストールを管理することをおすすめします。

ターミナルを開いて、次のコマンドを実行します。

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

システムによっては、コマンドの前に sudo。

詳細

Ruby

最新の Ruby 用キャンペーン マネージャー 360 API クライアント ライブラリをインストールします。使用 インストールを管理する RubyGems をおすすめします。

ターミナルを開いて、次のコマンドを実行します。

gem install google-api-client

インストール済みのライブラリを 最新バージョン：

gem update -y google-api-client

システムによっては、コマンドの前に sudo。

詳細

その他の対応言語については、クライアント ライブラリ ページをご覧ください。

リクエストを作成する

OAuth 2.0 認証情報が作成されて、クライアント ライブラリが使用されます インストールすると、キャンペーン マネージャー 360 API を使用する準備が整いました。詳細 認証、構成、最初のリクエストの発行を行うには、次の手順を行います。 クイックスタートをご覧ください。

C#

  1. クライアント シークレット ファイルを読み込み、認証情報を生成します。

    この手順を初めて行うときは、ブラウザで承認プロンプトを受け入れるように求められます。承認する前に、キャンペーン マネージャー 360 へのアクセス権がある Google アカウントでログインしていることをご確認ください。現在ログインしているアカウントに代わって、アプリケーションがデータにアクセスすることが承認されます。 

    // 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. 承認済みの 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. オペレーションを実行する。

    // 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. クライアント シークレット ファイルを読み込み、認証情報を生成します。

    この手順を初めて行うときは、ブラウザで承認プロンプトを受け入れるように求められます。承認する前に、キャンペーン マネージャー 360 へのアクセス権がある Google アカウントでログインしていることをご確認ください。現在ログインしているアカウントに代わって、アプリケーションがデータにアクセスすることが承認されます。 

    // 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. 承認済みの 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. オペレーションを実行する。

    // 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. クライアント シークレット ファイルを読み込み、認証情報を生成します。

    この手順を初めて行うときは、ブラウザで承認プロンプトを受け入れるように求められます。承認する前に、キャンペーン マネージャー 360 へのアクセス権がある Google アカウントでログインしていることをご確認ください。現在ログインしているアカウントに代わって、アプリケーションがデータにアクセスすることが承認されます。 

    // 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. 承認済みの Dfareporting クライアントを作成します。

    // Create a Dfareporting service object.
$service = new Google_Service_Dfareporting($client);

  3. オペレーションを実行する。

    // 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. クライアント シークレット ファイルを読み込み、認証情報を生成します。

    この手順を初めて行うときは、ブラウザで承認プロンプトを受け入れるように求められます。承認する前に、キャンペーン マネージャー 360 へのアクセス権がある Google アカウントでログインしていることをご確認ください。現在ログインしているアカウントに代わって、アプリケーションがデータにアクセスすることが承認されます。 

    # 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. 承認済みの Dfareporting クライアントを作成します。

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

  3. オペレーションを実行する。

    # 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. クライアント シークレット ファイルを読み込み、認証情報を生成します。

    この手順を初めて行うときは、ブラウザで承認プロンプトを受け入れるように求められます。承認する前に、キャンペーン マネージャー 360 へのアクセス権がある Google アカウントでログインしていることをご確認ください。現在ログインしているアカウントに代わって、アプリケーションがデータにアクセスすることが承認されます。 

    # 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. 承認済みの 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. オペレーションを実行する。

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

その他の情報

Google API で提供されているすべてのサービスについては、API リファレンスをご覧ください。 説明します。すべてのメソッドの詳細ページに埋め込み API がある テスト リクエストを直接送信できます できます。

高度なトピックについて説明し、エンドツーエンドの 一般的なタスクの例をご覧ください。

コードを作成する準備ができたら、 コードサンプルのコレクション。このコードサンプルは変更や修正が ニーズに合わせて拡張できます