- リソース: Report
- ReportDefinition
- ディメンション
- 指標
- Filter
- FieldFilter
- Field
- 操作
- ReportValue
- IntList
- StringList
- DoubleList
- FilterList
- TimeZoneSource
- DateRange
- FixedDateRange
- 日付
- RelativeDateRange
- 並べ替え
- メソッド
リソース: Report
Report リソース。
| JSON 表現 |
|---|
{
"name": string,
"reportId": string,
"reportDefinition": {
object ( |
| フィールド | |
|---|---|
name |
ID。レポートのリソース名。レポート リソース名の形式は |
reportId |
出力専用。レポート ID。 |
reportDefinition |
必須。レポートのレポート定義。 |
displayName |
省略可。レポートの表示名。 |
updateTime |
出力専用。このレポートが最後に変更された日時。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
createTime |
出力専用。このレポートが作成された日時。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
locale |
出力専用。このレポートの言語 / 地域。言語 / 地域は、リクエスト時のユーザーの言語 / 地域から設定されます。ロケールは変更できません。 |
ReportDefinition
レポートの実行方法の定義。
| JSON 表現 |
|---|
{ "dimensions": [ enum ( |
| フィールド | |
|---|---|
dimensions[] |
必須。レポートを作成するディメンションのリスト。空の場合、レポートにはディメンションがなく、指標は合計になります。 |
metrics[] |
必須。レポート対象の指標のリスト。空の場合、レポートには指標がありません。 |
filters[] |
省略可。このレポートのフィルタ。 |
timeZoneSource |
省略可。このレポートのタイムゾーンの取得元。デフォルトでは、太平洋タイムゾーン(PT)が使用されます。ソースが PROVIDED の場合、レポート定義の timeZone フィールドにもタイムゾーンを設定する必要があります。 |
timeZone |
省略可。timeZoneSource が PROVIDED の場合、これはこのレポートに使用するタイムゾーンです。他のタイムゾーン ソースの場合は空欄のままにします。IANA 形式のタイムゾーン。たとえば、America/New_York。 |
currencyCode |
省略可。このレポートの ISO 4217 通貨コード。指定しない場合は、デフォルトでアカウントの通貨コードになります。 |
dateRange |
必須。このレポートのメインの期間。 |
sorts[] |
省略可。このレポートに適用するデフォルトの並べ替え。 |
ディメンション
レポート ディメンション。
| 列挙型 | |
|---|---|
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 ( |
| フィールド | |
|---|---|
| タイプによって、基になるフィルタの組み合わせ方法が決まります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
fieldFilter |
単一フィールドのフィルタ。 |
notFilter |
結果が否定されるフィルタ。 |
andFilter |
結果が AND 演算されるフィルタのリスト。 |
orFilter |
結果が OR 演算されるフィルタのリスト。 |
| 相互に排他的なフィールドの終了。 | |
FieldFilter
特定のフィールドのフィルタ。
| JSON 表現 |
|---|
{ "field": { object ( |
| フィールド | |
|---|---|
field |
必須。フィルタリングするフィールド。 |
operation |
必須。このフィルタのオペレーション。 |
values[] |
必須。フィルタする値。 |
フィールド
レポートのディメンションまたは指標。
| JSON 表現 |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "dimension": enum ( |
| フィールド | |
|---|---|
| ディメンションまたは指標。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
dimension |
このフィールドが表すディメンション。 |
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 ( |
| フィールド | |
|---|---|
| フィールドの値は、フィールドのデータ形式によって異なります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
intValue |
整数値の場合。 |
doubleValue |
double 値の場合。 |
stringValue |
文字列値の場合。 |
boolValue |
ブール値の場合。 |
intListValue |
整数値のリストの場合。 |
stringListValue |
文字列値のリスト。 |
doubleListValue |
double 値のリスト。 |
bytesValue |
バイト値の場合。 Base64 でエンコードされた文字列。 |
| 相互に排他的なフィールドの終了。 | |
IntList
整数値のリスト。
| JSON 表現 |
|---|
{ "values": [ string ] } |
| フィールド | |
|---|---|
values[] |
値 |
StringList
文字列値のリスト。
| JSON 表現 |
|---|
{ "values": [ string ] } |
| フィールド | |
|---|---|
values[] |
値 |
DoubleList
double 値のリスト。
| JSON 表現 |
|---|
{ "values": [ number ] } |
| フィールド | |
|---|---|
values[] |
値 |
FilterList
フィルタのリスト。
| JSON 表現 |
|---|
{
"filters": [
{
object ( |
| フィールド | |
|---|---|
filters[] |
必須。フィルタのリスト。 |
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 ( |
| フィールド | |
|---|---|
| 固定期間または相対期間。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
fixed |
固定期間。 |
relative |
相対期間。 |
| 相互に排他的なフィールドの終了。 | |
FixedDateRange
2 つの固定日付の間の期間(終了日を含む)。
| JSON 表現 |
|---|
{ "startDate": { object ( |
| フィールド | |
|---|---|
startDate |
必須。この期間の開始日。 |
endDate |
必須。この期間の終了日(指定日も期間に含む)。 |
日付
誕生日などのように、カレンダーの日付全体またはその一部を表します。時間帯とタイムゾーンは、他の場所で指定されているか、重要ではありません。日付は西暦を基準にしており、これは次のいずれかを表します。
- 年の値がゼロ以外である月と日の値を含む完全な日付
- 年の値がゼロである月と日(記念日など)。
- 月と日の値がゼロである単独の年。
- 日の値がゼロである年と月(クレジット カードの有効期限など)
関連するタイプ:
google.type.TimeOfDaygoogle.type.DateTimegoogle.protobuf.Timestamp
| JSON 表現 |
|---|
{ "year": integer, "month": integer, "day": integer } |
| フィールド | |
|---|---|
year |
その日付の年。1~9999、または年のない日付を指定する場合は 0 にする必要があります。 |
month |
1 年の中の月。1~12、または月と日のない年を指定する場合は 0 にする必要があります。 |
day |
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 |
省略可。並べ替え順。true の場合、並べ替えは降順になります。 |
メソッド |
|
|---|---|
|
Report オブジェクトを作成します。 |
|
Report オブジェクトを削除します。 |
|
Report オブジェクトを取得します。 |
|
Report オブジェクトを一覧表示します。 |
|
Report オブジェクトを更新します。 |
|
既存のレポートの実行を非同期で開始します。 |