初めてのアプリ: 前提条件

最初のクライアント アプリケーションのコーディングを開始する前に、行うことがいくつかあります。

Google アカウントを作成して検索広告 360 の権限を取得する

検索広告 360 API を使用するには、Google アカウントと、検索広告 360 から対象のアカウントに対する適切な権限を付与する必要があります。

  1. Google アカウントをまだお持ちでない場合は、アカウントを作成してください。

  2. 検索広告 360 の代理店マネージャーに、Google アカウントの検索広告 360 ユーザーの作成を依頼します。

    レポートをダウンロードするには、対象の広告主に対する表示権限が必要です。

    コンバージョンを追加または編集するには、使用する広告主に対する編集権限が必要です。Floodlight 設定を共有している場合、コンバージョンをアップロードする子広告主ごとに編集権限が必要です。 親広告主へのアクセスは必要ありません。また、コンバージョンをアップロードしていない子広告主にもアクセスする必要はありません。クリック ID を使用してコンバージョンを訪問に結び付ける場合は、クリック ID を生成した広告主に対する編集権限があることを確認します。編集権限のない広告主のクリック ID を指定した場合、リクエストは成功しません。

    代理店マネージャーは、特定の広告主へのアクセス権を持つ広告主ユーザーとしてアカウントを設定するか、代理店のすべての広告主へのアクセス権を持つ高度なアクセス権（代理店ユーザーなど）を設定します。

API 変換サービスを有効にする

コンバージョンに関するデータをアップロードするには、代理店マネージャーの権限を持つ検索広告 360 のユーザーが、検索広告 360 の UI にログインして API コンバージョン サービスを有効にする必要があります。手順については、検索広告 360 ヘルプセンターをご覧ください。

Google API Console プロジェクトとクライアントの OAuth 認証情報を作成する

  1. Google API Console 設定ツールを起動します。
    設定ツールを使用すると、プロジェクトを作成する（または既存のプロジェクトを使用する）、Search Ads 360 API を有効にする、OAuth 2.0 認証情報を作成する手順を行うことができます。
  2. [アプリケーションの登録] ページで既存のプロジェクトを選択するか、[プロジェクトを作成] を選択します。[続行] をクリックします。
  3. Google API Console で Search Ads 360 API を有効にしたら、[認証情報に移動] ボタンをクリックします。
  4. [認証情報を作成] ページで次の情報を入力します。
    • 使用している API:検索広告 360 API
    • アクセス対象のデータ:ユーザーデータ
  5. [次へ] ボタンをクリックします。

    設定ツールで、OAuth 2.0 クライアント ID の作成がサポートされるようになりました。

  6. 設定ツールの残りの手順を行います。

sa360Api.py をインストールする

検索広告 360 には、承認プロセスを設定するプロセスを支援するユーティリティ スクリプトが用意されています。また、完全なアプリケーションを設計して作成する前に、このスクリプトを使用して、JSON 形式のデータの送受信を行うこともできます。このドキュメント サイトの JSON の例の多くをコピーして、スクリプトに直接入力できます。

スクリプトをインストールするには:

  1. Python 2.7 をインストールします。
    スクリプトは Python 3.x では動作しません。
  2. cURL をインストールします。
  3. sa360Api.zip をダウンロードします。
  4. sa360Api.zip から sa360Api.py を抽出します。
  5. sa360Api.py を実行可能にします。

REST の基礎を学習する

API は次の 2 つの方法で呼び出すことができます。

クライアント ライブラリを使用しない場合は、REST の基礎を理解する必要があります。

REST は、データをリクエストして変更するための便利で一貫したアプローチを提供するソフトウェア アーキテクチャのスタイルです。

REST という用語は「Representational State Transfer」の省略形です。Google API のコンテキストでは、HTTP 動詞を使用して、Google が保存しているデータ表現を取得および変更することを表しています。

RESTful システムでは、リソースはデータストアに保存されており、クライアントはサーバーが特定のアクション（リソースの作成、取得、更新、削除など）を実行するようにリクエストを送信します。サーバーはそのアクションを実行し、多くの場合、指定されたリソースの表現形式でレスポンスを送信します。

Google の RESTful API では、クライアントは POST、GET、PUT、DELETE などの HTTP 動詞を使用してアクションを指定します。グローバルに一意の次の形式の URI でリソースを指定します。

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

すべての API リソースは HTTP でアクセス可能な一意の URI を持っているため、REST はデータ キャッシュを有効にし、ウェブの分散インフラストラクチャで動作するように最適化されています。

HTTP 1.1 標準のドキュメントのメソッド定義をご覧ください。GET、POST、PUT、DELETE の仕様が記載されています。

Search Ads 360 API の REST

Search Ads 360 API オペレーションは REST HTTP 動詞に直接マッピングされます。

検索広告 360 API URI の特定の形式:

https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters

API でサポートされている各オペレーションで使用される URI の一覧については、API リファレンスをご覧ください。

JSON の基礎を学習する

REST を使用する場合は、リクエスト本文に JSON 形式を使用する必要があります。レスポンスは JSON 形式または CSV 形式のいずれかで指定できます。

JSON（JavaScript Object Notation）は言語に依存しない一般的なデータ フォーマットで、任意のデータ構造を単純なテキスト形式で表すことができます。詳しくは json.org をご覧ください。