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

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

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

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

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

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

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

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

    代理店マネージャーは、特定の広告主にアクセスできる広告主ユーザーとしてアカウントを設定することも、代理店内のすべての広告主にアクセスできる代理店ユーザーなど、より高いレベルのアクセス権を持つアカウントとして設定することもできます。

API コンバージョン サービスを有効にする

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

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

  1. Google API コンソールの セットアップ ツールを起動します。
    設定ツールの手順に沿って、プロジェクトの作成（または既存のプロジェクトを使用）、Search Ads 360 API の有効化、OAuth 2.0 認証情報の作成を行います。
  2. [アプリケーションを登録する] ページで、既存のプロジェクトを選択するか、[プロジェクトを作成] を選択します。その後、[続行] をクリックします。
  3. Google API Console で検索広告 360 API が有効になったら、[認証情報に進む] ボタンをクリックします。
  4. [認証情報を作成] ページで、次の情報を入力します。
    • 使用している API: Search Ads 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 動詞に直接マッピングされています。

Search Ads 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 をご覧ください。