FloodlightActivities: list

Floodlight アクティビティの一覧を取得します。結果をフィルタできます。このメソッドはページングをサポートします。実習をご覧ください。

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/floodlightActivities

パラメータ

パラメータ名 説明
パス パラメータ
profileId long このリクエストに関連付けられるユーザー プロフィール ID。
省略可能なクエリ パラメータ
advertiserId long 指定した広告主 ID を持つ Floodlight アクティビティのみを選択します。空でない結果を表示するには、idsadvertiserIdfloodlightConfigurationId のいずれかを指定する必要があります。
floodlightActivityGroupIds long 指定した Floodlight アクティビティ グループ ID を持つ Floodlight アクティビティのみを選択します。
floodlightActivityGroupName string 指定した Floodlight アクティビティ グループ名を持つ Floodlight アクティビティのみを選択します。
floodlightActivityGroupTagString string 指定した Floodlight アクティビティ グループのタグ文字列を持つ Floodlight アクティビティのみを選択します。
floodlightActivityGroupType string 指定した Floodlight アクティビティ グループのタイプを持つ Floodlight アクティビティのみを選択します。

有効な値は次のとおりです。
  • "COUNTER"
  • SALE
floodlightConfigurationId long 指定した Floodlight 設定 ID を持つ Floodlight アクティビティのみを選択します。空でない結果を表示するには、idsadvertiserIdfloodlightConfigurationId のいずれかを指定する必要があります。
ids long 指定した ID を持つ Floodlight アクティビティのみを選択します。空でない結果を表示するには、idsadvertiserIdfloodlightConfigurationId のいずれかを指定する必要があります。
maxResults integer 表示する結果の最大数。設定可能な値は 01000 です。デフォルトは 1000 です。
pageToken string 前回の結果ページの nextPageToken の値。
searchString string 名前または ID でオブジェクトを検索できます。ワイルドカード(*)を使用できます。たとえば、"floodlightactivity*2015" を検索すると、"floodlightactivity June 2015""floodlightactivity April 2015"、または単に "floodlightactivity 2015" のような名前を持つオブジェクトが返されます。また、ほとんどの検索では、検索文字列の前後に非明示的なワイルドカードが追加されます。たとえば、"floodlightactivity" という検索文字列は、"my floodlightactivity activity""floodlightactivity 2015"、または単に "floodlightactivity" という名前のオブジェクトに一致します。
sortField string リストの並べ替えに使用するフィールド。

設定可能な値は次のとおりです。
  • "ID"(デフォルト)
  • "NAME"
sortOrder string 結果の並べ替え順序。

設定可能な値は次のとおりです。
  • "ASCENDING"(デフォルト)
  • DESCENDING
tagString string 指定したタグ文字列を持つ Floodlight アクティビティのみを選択します。

認証

このリクエストには、次のスコープによる認証が必要です。

スコープ
https://www.googleapis.com/auth/dfatrafficking

詳しくは、認証と認可のページをご覧ください。

リクエストの本体

このメソッドでは、リクエストの本体を指定しません。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "kind": "dfareporting#floodlightActivitiesListResponse",
  "nextPageToken": string,
  "floodlightActivities": [
    floodlightActivities Resource
  ]
}
プロパティ名 説明 メモ
kind string リソースの種類を示します。値は固定文字列 "dfareporting#floodlightActivitiesListResponse" です。
floodlightActivities[] list Floodlight アクティビティのコレクション。
nextPageToken string 次のリストに移動する操作に使用されるページ分けトークン。

試してみる

以下の API Explorer を使用し、ライブデータに対してこのメソッドを呼び出して、レスポンスを確認してみましょう。