REST Resource: curators.reports

リソース: Report

Report リソース。

JSON 表現
{
  "name": string,
  "reportId": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "displayName": string,
  "updateTime": string,
  "createTime": string,
  "locale": string
}
フィールド
name

string

ID。レポートのリソース名。レポート リソース名の形式は curators/{accountId}/reports/{reportId} です。

reportId

string (int64 format)

出力専用。レポート ID。

reportDefinition

object (ReportDefinition)

必須。レポートのレポート定義。

displayName

string

省略可。レポートの表示名。

updateTime

string (Timestamp format)

出力専用。このレポートが最後に変更された日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

createTime

string (Timestamp format)

出力専用。このレポートが作成された日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

locale

string

出力専用。このレポートの言語 / 地域。言語 / 地域は、リクエスト時のユーザーの言語 / 地域から設定されます。ロケールは変更できません。

ReportDefinition

レポートの実行方法の定義。

JSON 表現
{
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "filters": [
    {
      object (Filter)
    }
  ],
  "timeZoneSource": enum (TimeZoneSource),
  "timeZone": string,
  "currencyCode": string,
  "dateRange": {
    object (DateRange)
  },
  "sorts": [
    {
      object (Sort)
    }
  ]
}
フィールド
dimensions[]

enum (Dimension)

必須。レポートを作成するディメンションのリスト。空の場合、レポートにはディメンションがなく、指標は合計になります。

metrics[]

enum (Metric)

必須。レポート対象の指標のリスト。空の場合、レポートには指標がありません。

filters[]

object (Filter)

省略可。このレポートのフィルタ。

timeZoneSource

enum (TimeZoneSource)

省略可。このレポートのタイムゾーンの取得元。デフォルトでは、太平洋タイムゾーン(PT)が使用されます。ソースが PROVIDED の場合、レポート定義の timeZone フィールドにもタイムゾーンを設定する必要があります。

timeZone

string

省略可。timeZoneSource が PROVIDED の場合、これはこのレポートに使用するタイムゾーンです。他のタイムゾーン ソースの場合は空欄のままにします。IANA 形式のタイムゾーン。たとえば、America/New_York。

currencyCode

string

省略可。このレポートの ISO 4217 通貨コード。指定しない場合は、デフォルトでアカウントの通貨コードになります。

dateRange

object (DateRange)

必須。このレポートのメインの期間。

sorts[]

object (Sort)

省略可。このレポートに適用するデフォルトの並べ替え。

ディメンション

レポート ディメンション。

列挙型
DIMENSION_UNSPECIFIED デフォルト値。この値は使用されません。
ADVERTISER_DOMAIN 広告主のドメイン。
COUNTRY 国の表示名。
CURATION_DATA_SEGMENT_ID キュレーターが作成したデータ セグメントの ID。
CURATION_DATA_SEGMENT_RESPONSE_STATUS リアルタイム キュレーションでのデータ セグメント リクエストのレスポンス ステータス。詳しくは、https://developers.google.com/authorized-buyers/curation/get-started/start をご覧ください。
CURATION_DATA_SEGMENT_RESPONSE_STATUS_NAME リアルタイム キュレーションにおけるデータ セグメント リクエストのレスポンス ステータスのローカライズされた表示名。詳しくは、https://developers.google.com/authorized-buyers/curation/get-started/start をご覧ください。
CURATOR_FEE_TYPE キュレーション サービスの種類(パッケージ化、データ セグメントなど)。
DATE 日付。
DEAL_ID 取引 ID。
DEAL_NAME 取引名。
DETECTED_ADVERTISER_NAME 検出された広告主の表示名。
DSP_NAME DSP の表示名。
DSP_SEAT_ID DSP シート ID。
ENVIRONMENT インプレッションが発生したユーザー デバイスとコンテナ環境。サポートされている値は「app」と「web」です。
ENVIRONMENT_NAME インプレッションが発生したユーザー デバイスとコンテナ環境のローカライズされた表示名。サポートされている値は「app」と「web」です。
HOLDING_COMPANY_NAME 持ち株会社の表示名。
HOUR 時間。
MOBILE_APP_ID モバイルアプリ ID。
MOBILE_APP_NAME モバイルアプリ名。
MOBILE_OS モバイル オペレーティング システム。
MONTH 月別] をタップします。
PACKAGE_FEE_VISIBILITY パッケージ料金の公開設定(公開または非公開など)。
PLATFORM プラットフォーム(「パソコン」と「モバイル」など)。
PUBLISHER_DOMAIN パブリッシャーのドメイン。
PUBLISHER_ID パブリッシャーの識別子。
PUBLISHER_NAME パブリッシャー名。
WEEK 週。

指標

レポート指標。

列挙型
METRIC_UNSPECIFIED デフォルト値。この値は使用されません。
ACTIVE_VIEW_MEASURABILITY_RATE アクティブ ビュー測定可能率。
ACTIVE_VIEW_MEASURABLE アクティブ ビュー測定可能。
ACTIVE_VIEW_VIEWABILITY_RATE アクティブ ビュー視認可能率。
ACTIVE_VIEW_VIEWABLE アクティブ ビュー視認範囲のインプレッション数
AUCTIONS_WON オークションで落札。
BIDS 入札単価。
BIDS_IN_AUCTION オークションの入札数。
BID_REQUESTS 入札リクエスト。
CLICKS Clicks.
CURATION_PARTNER_FEE キュレーター料金。パッケージの公開設定が非公開に設定されている場合、この値は 0.00 に編集されます。PACKAGE_FEE_VISIBILITY ディメンションを使用して、パッケージの料金が公開されているかどうかを確認します。
DATA_SEGMENT_REQUESTS リアルタイム キュレーションで送信されたデータ セグメント リクエストの数。
IMPRESSIONS インプレッション。
SPEND リクエストで指定されたレポート通貨での費用。デフォルトは USD です。

フィルタ

1 つ以上のフィールドに対するフィルタ。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fieldFilter": {
    object (FieldFilter)
  },
  "notFilter": {
    object (Filter)
  },
  "andFilter": {
    object (FilterList)
  },
  "orFilter": {
    object (FilterList)
  }
  // End of mutually exclusive fields.
}
フィールド
タイプによって、基になるフィルタの組み合わせ方法が決まります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
fieldFilter

object (FieldFilter)

単一フィールドのフィルタ。

notFilter

object (Filter)

結果が否定されるフィルタ。

andFilter

object (FilterList)

結果が AND 演算されるフィルタのリスト。

orFilter

object (FilterList)

結果が OR 演算されるフィルタのリスト。

相互に排他的なフィールドの終了。

FieldFilter

特定のフィールドのフィルタ。

JSON 表現
{
  "field": {
    object (Field)
  },
  "operation": enum (Operation),
  "values": [
    {
      object (ReportValue)
    }
  ]
}
フィールド
field

object (Field)

必須。フィルタリングするフィールド。

operation

enum (Operation)

必須。このフィルタのオペレーション。

values[]

object (ReportValue)

必須。フィルタする値。

フィールド

レポートのディメンションまたは指標。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of mutually exclusive fields.
}
フィールド
ディメンションまたは指標。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
dimension

enum (Dimension)

このフィールドが表すディメンション。

metric

enum (Metric)

このフィールドが表す指標。

相互に排他的なフィールドの終了。

オペレーション

サポートされているフィルタ オペレーション。

列挙型
IN

スカラー オペランドの場合、オペランドが指定されたフィルタ値のセットに含まれているかどうかを確認します。

リスト オペランドの場合、オペランド内の要素が、指定されたフィルタ値のセットに含まれているかどうかを確認します。

デフォルト値。

NOT_IN

スカラー オペランドの場合、オペランドが指定されたフィルタ値のセットに含まれていないことを確認します。

リスト オペランドの場合、オペランド内の要素が、指定されたフィルタ値のセットに含まれていないことを確認します。

CONTAINS

スカラー文字列オペランドの場合、オペランドに指定されたフィルタ部分文字列が含まれているかどうかを確認します。

文字列リストのオペランドの場合、オペランド内の文字列に、指定されたフィルタ部分文字列が含まれているかどうかを確認します。

NOT_CONTAINS

スカラー文字列オペランドの場合、オペランドに指定されたフィルタ部分文字列が含まれていないことを確認します。

文字列リストのオペランドの場合、オペランド内の文字列に、指定されたフィルタ部分文字列が含まれていないことを確認します。

LESS_THAN オペランドが指定されたフィルタ値より小さい。
LESS_THAN_EQUALS オペランドが指定されたフィルタ値以下。
GREATER_THAN オペランドが指定されたフィルタ値より大きい。
GREATER_THAN_EQUALS オペランドが指定されたフィルタ値以上です。
BETWEEN オペランドが指定されたフィルタ値の間にある。
MATCHES オペランドが正規表現または正規表現のセットと一致します(1 つが一致する必要があります)。
NOT_MATCHES オペランドが正規表現または正規表現のセットと一致しない(一致するものがない)。

ReportValue

レポート内の単一の値を表します。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "intValue": string,
  "doubleValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "intListValue": {
    object (IntList)
  },
  "stringListValue": {
    object (StringList)
  },
  "doubleListValue": {
    object (DoubleList)
  },
  "bytesValue": string
  // End of mutually exclusive fields.
}
フィールド
フィールドの値は、フィールドのデータ形式によって異なります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
intValue

string (int64 format)

整数値の場合。

doubleValue

number

double 値の場合。

stringValue

string

文字列値の場合。

boolValue

boolean

ブール値の場合。

intListValue

object (IntList)

整数値のリストの場合。

stringListValue

object (StringList)

文字列値のリスト。

doubleListValue

object (DoubleList)

double 値のリスト。

bytesValue

string (bytes format)

バイト値の場合。

Base64 でエンコードされた文字列。

相互に排他的なフィールドの終了。

IntList

整数値のリスト。

JSON 表現
{
  "values": [
    string
  ]
}
フィールド
values[]

string (int64 format)

値

StringList

文字列値のリスト。

JSON 表現
{
  "values": [
    string
  ]
}
フィールド
values[]

string

値

DoubleList

double 値のリスト。

JSON 表現
{
  "values": [
    number
  ]
}
フィールド
values[]

number

値

FilterList

フィルタのリスト。

JSON 表現
{
  "filters": [
    {
      object (Filter)
    }
  ]
}
フィールド
filters[]

object (Filter)

必須。フィルタのリスト。

TimeZoneSource

レポートのタイムゾーンを決定するソース。

列挙型
TIME_ZONE_SOURCE_UNSPECIFIED 未指定のデフォルト値。
AD_EXCHANGE 太平洋時間(PT)を使用します。
UTC UTC タイムゾーンを使用します。
PROVIDED ReportDefinition.time_zone フィールドで指定されたタイムゾーンを使用します。日付はリクエスト時に動的に計算されるため、レポートの実行に時間がかかることがあります。
CURATOR キュレーターのアカウント設定のタイムゾーンを使用します。

DateRange

レポートの期間。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fixed": {
    object (FixedDateRange)
  },
  "relative": enum (RelativeDateRange)
  // End of mutually exclusive fields.
}
フィールド
固定期間または相対期間。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
fixed

object (FixedDateRange)

固定期間。

relative

enum (RelativeDateRange)

相対期間。

相互に排他的なフィールドの終了。

FixedDateRange

2 つの固定日付の間の期間(終了日を含む)。

JSON 表現
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
フィールド
startDate

object (Date)

必須。この期間の開始日。

endDate

object (Date)

必須。この期間の終了日(指定日も期間に含む)。

日付

誕生日などのように、カレンダーの日付全体またはその一部を表します。時間帯とタイムゾーンは、他の場所で指定されているか、重要ではありません。日付は西暦を基準にしており、これは次のいずれかを表します。

  • 年の値がゼロ以外である月と日の値を含む完全な日付
  • 年の値がゼロである月と日(記念日など)。
  • 月と日の値がゼロである単独の年。
  • 日の値がゼロである年と月(クレジット カードの有効期限など)

関連するタイプ:

JSON 表現
{
  "year": integer,
  "month": integer,
  "day": integer
}
フィールド
year

integer

その日付の年。1~9999、または年のない日付を指定する場合は 0 にする必要があります。

month

integer

1 年の中の月。1~12、または月と日のない年を指定する場合は 0 にする必要があります。

day

integer

1 月の中の日付。1~31 で、その年と月で有効な値にする必要があります。または、日が重要でない場合は年のみか年と月を指定するには 0 にする必要があります。

RelativeDateRange

相対期間のオプション。

列挙型
RELATIVE_DATE_RANGE_UNSPECIFIED デフォルト値。この値は使用されません。
TODAY レポートが実行された日付。
YESTERDAY レポートが実行された日の前日。
THIS_WEEK_TO_DATE レポートが実行された日を含む暦週の初めから。
THIS_WEEK_TO_YESTERDAY レポートが実行された暦週の初めから、レポートが実行された日の前日(指定した日も期間に含む)まで。
THIS_MONTH_TO_DATE レポートが実行された暦月の初日から、レポートが実行された日まで(その日を含む)。
THIS_MONTH_TO_YESTERDAY レポートが実行された暦月の初日から、レポートが実行された日の前日(その日を含む)まで。
THIS_QUARTER_TO_DATE レポートが実行された暦四半期の初日から、レポートが実行された日(その日を含む)まで。
THIS_QUARTER_TO_YESTERDAY レポートが実行された暦四半期の初日から、レポートが実行された日の前日(指定した日も期間に含む)まで。
THIS_YEAR_TO_DATE レポートが実行された暦年の初めから、レポートが実行された日(指定した日も期間に含む)まで。
THIS_YEAR_TO_YESTERDAY レポートが実行された暦年の初日から、レポートが実行された日の前日までの期間。
LAST_WEEK レポートが実行される暦週の前の暦週全体(月曜日から日曜日まで)。
LAST_WEEK_STARTING_SUNDAY レポートが実行された暦週の前の暦週全体(日曜日から土曜日まで)。
LAST_MONTH レポートが実行された暦月の前の暦月全体。
LAST_QUARTER レポートが実行される暦四半期より前の暦四半期全体。
LAST_YEAR レポートが実行された暦年の前年全体。
LAST_7_DAYS レポートの作成日から 7 日前まで。
LAST_30_DAYS レポートの作成日から 30 日前まで。
LAST_60_DAYS レポートの作成日から 60 日前まで。
LAST_90_DAYS レポートの作成日から 90 日前まで。
LAST_93_DAYS レポートの作成日から 93 日前まで。
LAST_180_DAYS レポートの作成日から 180 日前まで。
LAST_360_DAYS レポートの作成日から 360 日前まで。
LAST_365_DAYS レポートの作成日から 365 日前まで。
LAST_3_MONTHS レポートが実行された暦月の前の 3 暦月全体。
LAST_6_MONTHS レポートが実行された暦月の前の 6 暦月全体。
LAST_12_MONTHS レポートが実行された暦月の前の 12 暦月全体。
ALL_AVAILABLE レポートの作成日から 3 年前から、レポートの作成日の前日まで(指定した日も期間に含む)。

並べ替え

レポートの並べ替えを表します。

JSON 表現
{
  "field": {
    object (Field)
  },
  "descending": boolean
}
フィールド
field

object (Field)

必須。並べ替えの基準となるフィールド(ディメンションまたは指標)。

descending

boolean

省略可。並べ替え順。true の場合、並べ替えは降順になります。

メソッド

create

Report オブジェクトを作成します。

delete

Report オブジェクトを削除します。

get

Report オブジェクトを取得します。

list

Report オブジェクトを一覧表示します。

patch

Report オブジェクトを更新します。

run

既存のレポートの実行を非同期で開始します。