エンティティスナップショット

警告

現在広告APIは、スポンサーブランド動画広告キャンペーン、またはバージョン4のエンドポイントを使用して作成されたキャンペーンのスナップショットに対応していません。スナップショットには、バージョン3の動画以外のキャンペーンのみのレコードが含まれます。

キャンペーンおよびキーワードのレコードを一括で取得するために使用します。このインターフェイスは、一括アカウントスナップショットファイルを非同期的にダウンロードするために使用されます。

メソッド	URL	ユースケース
POST	/v2/hsa/{recordType}/snapshot	フィルター条件を満たす、アカウント内の指定されたタイプのすべてのエンティティのファイルベースのスナップショットをリクエストします。
GET	/v2/hsa/snapshots/{snapshotId}	以前にリクエストしたスナップショットのステータス、メタデータ、場所を取得します。

操作

requestSnapshot

POST /v2/hsa/{recordType}/snapshot    

{                                
  "stateFilter":{stateFilter}     
}

スポンサープロダクト広告またはスポンサーブランド広告における1つのレコードタイプの全エンティティに対するスナップショットレポートをリクエストします。

パラメーター

パラメーター名	タイプ	指定対象	説明
recordType	String	URL	スナップショットを生成する対象となるエンティティのタイプ。これは、campaignsまたはkeywordsのいずれかにする必要があります。
stateFilter	String	POSTボディ	カンマ区切りリストで指定された状態のエンティティに関する結果のみを返します。enabled、paused、archivedのいずれかにする必要があります。デフォルト動作では、enabledとpausedが含まれます。

レスポンス

ステータスコード	レスポンスオブジェクト
202 - success	SnapshotResponse
401 - unauthorized	Error

SnapshotResponseには、スナップショットのステータスが入ります。スナップショットが完了すると 追加のメタデータが取り込まれ、locationヘッダーで 生成されるレポートの場所を指定します。

リソースの表現

SnapshotResponse

{
    "title": "SnapshotResponse",
    "type": "object",
    "properties": {   
      "snapshotId": {
           "description": "The ID of the snapshot that was requested.",
           "type": "string"
       },
      "recordType": {
           "description": "The record type of the report.",
           "type": "string",
           "oneOf": ["campaigns","keywords"]
       },
       "status": {
           "description": "The status of the generation of the snapshot.",
           "type": "string",
           "oneOf":["IN_PROGRESS","SUCCESS","FAILURE"]
       },
       "statusDetails": {
           "description": "Description of the status.",
           "type": "string"
       },
       "location": {
           "description": "The URI for the snapshot.It's only available if status is SUCCESS.",
           "type": "string"
       },
       "fileSize": {
           "description": "The size of the snapshot file in bytes.It's only available if status is SUCCESS.",
           "type": "number"
       },
       "expiration": {
           "description": "The epoch time for expiration of the snapshot file.It's only available if status is SUCCESS.",
           "type": "number"
       }
    }
}

エラー

開発者メモのエラーレスポンスオブジェクトをご覧ください。