Reports

このリソースのメソッドの一覧は、このページの最後に掲載されています。

リソース表記

レポートを表します。

{
  "key": {
    "queryId": long,
    "reportId": long
  },
  "metadata": {
    "status": {
      "state": string,
      "failure": {
        "errorCode": string
      },
      "finishTimeMs": long,
      "format": string
    },
    "reportDataStartTimeMs": long,
    "reportDataEndTimeMs": long,
    "googleCloudStoragePath": string
  },
  "params": {
    "type": string,
    "groupBys": [
      string
    ],
    "filters": [
      {
        "type": string,
        "value": string
      }
    ],
    "metrics": [
      string
    ],
    "includeInviteData": boolean
  }
}
プロパティ名 値 説明 メモ
key nested object レポートの識別に使用されるキー。
key.queryId long クエリ ID
key.reportId long レポート ID。
metadata nested object レポート メタデータ。
metadata.googleCloudStoragePath string レポートを保存する Google Cloud Storage 内の場所のパス。
metadata.reportDataEndTimeMs long レポートに表示されるデータの終了日時。
metadata.reportDataStartTimeMs long レポートに表示されるデータの開始時間。
metadata.status nested object レポートのステータス。
metadata.status.failure nested object レポートが失敗した場合は、原因が記録されます。
metadata.status.failure.errorCode string レポートが作成されない理由を示すエラーコード。

有効な値は次のとおりです。
  • 「AUTHENTICATION_ERROR」
  • 「DEPRECATED_REPORTING_INVALID_QUERY」
  • 「REPORTING_BUCKET_NOT_FOUND」
  • 「REPORTING_CREATE_BUCKET_FAILED」
  • 「REPORTING_DELETE_BUCKET_FAILED」
  • 「REPORTING_FATAL_ERROR」
  • 「REPORTING_ILLEGAL_FILENAME」
  • 「REPORTING_IMCOMPATIBLE_METRICS」
  • 「REPORTING_INVALID_QUERY_MISSING_PARTNER_AND_ADVERTISER_FILTERS」
  • 「REPORTING_INVALID_QUERY_TITLE_MISSING」
  • 「REPORTING_INVALID_QUERY_TOO_MANY_UNFILTERED_LARGE_GROUP_BYS」
  • 「REPORTING_QUERY_NOT_FOUND」
  • 「REPORTING_TRANSIENT_ERROR」
  • 「REPORTING_UPDATE_BUCKET_PERMISSION_FAILED」
  • 「REPORTING_WRITE_BUCKET_OBJECT_FAILED」
  • 「SERVER_ERROR」
  • 「UNAUTHORIZED_API_ACCESS」
  • 「VALIDATION_ERROR」
metadata.status.finishTimeMs long このレポートが完了した時刻または失敗した時刻。
metadata.status.format string レポートのファイル形式。

有効な値は次のとおりです。
  • 「CSV」
  • 「EXCEL_CSV」
  • 「XLSX」
metadata.status.state string レポートの状態。

有効な値は次のとおりです。
  • 「DONE」
  • 「FAILED」
  • 「RUNNING」
params nested object レポート パラメータ。
params.filters[] list レポート内のトラフィック データを照合するために使用されるフィルタ。
params.filters[].type string フィルタの種類。

有効な値は次のとおりです。
  • 「FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY」
  • 「FILTER_ACTIVITY_ID」
  • 「FILTER_ADVERTISER」
  • 「FILTER_ADVERTISER_CURRENCY」
  • 「FILTER_ADVERTISER_TIMEZONE」
  • 「FILTER_AD_POSITION」
  • 「FILTER_AGE」
  • 「FILTER_AUTHORIZED_SELLER_STATE_ID」
  • 「FILTER_BRANDSAFE_CHANNEL_ID」
  • 「FILTER_BROWSER」
  • 「FILTER_BUDGET_SEGMENT_DESCRIPTION」
  • 「FILTER_CAMPAIGN_DAILY_FREQUENCY」
  • 「FILTER_CARRIER」
  • 「FILTER_CHANNEL_ID」
  • 「FILTER_CITY」
  • 「FILTER_COMPANION_CREATIVE_ID」
  • 「FILTER_CONVERSION_DELAY」
  • 「FILTER_COUNTRY」
  • 「FILTER_CREATIVE_ATTRIBUTE」
  • 「FILTER_CREATIVE_HEIGHT」
  • 「FILTER_CREATIVE_ID」
  • 「FILTER_CREATIVE_SIZE」
  • 「FILTER_CREATIVE_TYPE」
  • 「FILTER_CREATIVE_WIDTH」
  • 「FILTER_DATA_PROVIDER」
  • 「FILTER_DATE」
  • 「FILTER_DAY_OF_WEEK」
  • 「FILTER_DEVICE_MAKE」
  • 「FILTER_DEVICE_MODEL」
  • 「FILTER_DEVICE_TYPE」
  • 「FILTER_DFP_ORDER_ID」
  • 「FILTER_DMA」
  • 「FILTER_DV360_ACTIVITY_ID」
  • 「FILTER_EXCHANGE_ID」
  • 「FILTER_FLOODLIGHT_ACTIVITY_ID」
  • 「FILTER_FLOODLIGHT_PIXEL_ID」
  • 「FILTER_GENDER」
  • 「FILTER_INSERTION_ORDER」
  • 「FILTER_INVENTORY_COMMITMENT_TYPE」
  • 「FILTER_INVENTORY_DELIVERY_METHOD」
  • 「FILTER_INVENTORY_FORMAT」
  • 「FILTER_INVENTORY_RATE_TYPE」
  • 「FILTER_INVENTORY_SOURCE」
  • 「FILTER_INVENTORY_SOURCE_TYPE」
  • 「FILTER_KEYWORD」
  • 「FILTER_LINE_ITEM」
  • 「FILTER_LINE_ITEM_DAILY_FREQUENCY」
  • 「FILTER_LINE_ITEM_LIFETIME_FREQUENCY」
  • 「FILTER_LINE_ITEM_TYPE」
  • 「FILTER_MEDIA_PLAN」
  • 「FILTER_MOBILE_DEVICE_MAKE」
  • 「FILTER_MOBILE_DEVICE_MAKE_MODEL」
  • 「FILTER_MOBILE_DEVICE_TYPE」
  • 「FILTER_MOBILE_GEO」
  • 「FILTER_MONTH」
  • 「FILTER_MRAID_SUPPORT」
  • 「FILTER_NIELSEN_AGE」
  • 「FILTER_NIELSEN_COUNTRY_CODE」
  • 「FILTER_NIELSEN_DEVICE_ID」
  • 「FILTER_NIELSEN_GENDER」
  • 「FILTER_NOT_SUPPORTED」
  • 「FILTER_ORDER_ID」
  • 「FILTER_OS」
  • 「FILTER_PAGE_CATEGORY」
  • 「FILTER_PAGE_LAYOUT」
  • 「FILTER_PARTNER」
  • 「FILTER_PARTNER_CURRENCY」
  • 「FILTER_PUBLIC_INVENTORY」
  • 「FILTER_QUARTER」
  • 「FILTER_REGION」
  • 「FILTER_REGULAR_CHANNEL_ID」
  • 「FILTER_SITE_ID」
  • 「FILTER_SITE_LANGUAGE」
  • 「FILTER_SKIPPABLE_SUPPORT」
  • 「FILTER_TARGETED_USER_LIST」
  • 「FILTER_TIME_OF_DAY」
  • 「FILTER_TRUEVIEW_AD_GROUP_AD_ID」
  • 「FILTER_TRUEVIEW_AD_GROUP_ID」
  • 「FILTER_TRUEVIEW_AGE」
  • 「FILTER_TRUEVIEW_CATEGORY」
  • 「FILTER_TRUEVIEW_CITY」
  • 「FILTER_TRUEVIEW_CONVERSION_TYPE」
  • 「FILTER_TRUEVIEW_COUNTRY」
  • 「FILTER_TRUEVIEW_CUSTOM_AFFINITY」
  • 「FILTER_TRUEVIEW_DMA」
  • 「FILTER_TRUEVIEW_GENDER」
  • 「FILTER_TRUEVIEW_IAR_AGE」
  • 「FILTER_TRUEVIEW_IAR_CATEGORY」
  • 「FILTER_TRUEVIEW_IAR_CITY」
  • 「FILTER_TRUEVIEW_IAR_COUNTRY」
  • 「FILTER_TRUEVIEW_IAR_GENDER」
  • 「FILTER_TRUEVIEW_IAR_INTEREST」
  • 「FILTER_TRUEVIEW_IAR_LANGUAGE」
  • 「FILTER_TRUEVIEW_IAR_PARENTAL_STATUS」
  • 「FILTER_TRUEVIEW_IAR_REGION」
  • 「FILTER_TRUEVIEW_IAR_REMARKETING_LIST」
  • 「FILTER_TRUEVIEW_IAR_TIME_OF_DAY」
  • 「FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL」
  • 「FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO」
  • 「FILTER_TRUEVIEW_IAR_ZIPCODE」
  • 「FILTER_TRUEVIEW_INTEREST」
  • 「FILTER_TRUEVIEW_KEYWORD」
  • 「FILTER_TRUEVIEW_PARENTAL_STATUS」
  • 「FILTER_TRUEVIEW_PLACEMENT」
  • 「FILTER_TRUEVIEW_REGION」
  • 「FILTER_TRUEVIEW_REMARKETING_LIST」
  • 「FILTER_TRUEVIEW_URL」
  • 「FILTER_TRUEVIEW_ZIPCODE」
  • 「FILTER_UNKNOWN」
  • 「FILTER_USER_LIST」
  • 「FILTER_USER_LIST_FIRST_PARTY」
  • 「FILTER_USER_LIST_THIRD_PARTY」
  • 「FILTER_VIDEO_AD_POSITION_IN_STREAM」
  • 「FILTER_VIDEO_COMPANION_SIZE」
  • 「FILTER_VIDEO_COMPANION_TYPE」
  • 「FILTER_VIDEO_CREATIVE_DURATION」
  • 「FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE」
  • 「FILTER_VIDEO_DURATION_SECONDS」
  • 「FILTER_VIDEO_FORMAT_SUPPORT」
  • 「FILTER_VIDEO_INVENTORY_TYPE」
  • 「FILTER_VIDEO_PLAYER_SIZE」
  • 「FILTER_VIDEO_RATING_TIER」
  • 「FILTER_VIDEO_SKIPPABLE_SUPPORT」
  • 「FILTER_VIDEO_VPAID_SUPPORT」
  • 「FILTER_WEEK」
  • 「FILTER_YEAR」
  • 「FILTER_YOUTUBE_VERTICAL」
  • 「FILTER_ZIP_CODE」
params.filters[].value string フィルタの値。
params.groupBys[] list データは、このフィールドに表示されているフィルタでグループ化されます。
params.includeInviteData boolean 非推奨です。このフィールドは使用されなくなりました。
params.metrics[] list レポートの列として含める指標。
params.type string レポートタイプ。

タイプ固有の制限:
  • TYPE_ORDER_ID では、過去 60 日以内の期間を指定できます。
  • TYPE_AUDIENCE_COMPOSITION、TYPE_INVENTORY_AVAILABILITY、TYPE_TRUEVIEW_IAR のサポート期間は、最大で過去 30 日間です。


有効な値は次のとおりです。
  • 「TYPE_ACTIVE_GRP」: サポート終了
  • 「TYPE_AUDIENCE_COMPOSITION」
  • 「TYPE_AUDIENCE_PERFORMANCE」
  • 「TYPE_CLIENT_SAFE」
  • 「TYPE_COMSCORE_VCE」
  • 「TYPE_CROSS_FEE」: クロス パートナー料金レポート。
  • 「TYPE_CROSS_PARTNER」
  • 「TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER」
  • 「TYPE_ESTIMATED_CONVERSION」
  • 「TYPE_FEE」
  • 「TYPE_GENERAL」
  • 「TYPE_INVENTORY_AVAILABILITY」
  • 「TYPE_KEYWORD」
  • 「TYPE_LINEAR_TV_SEARCH_LIFT」
  • 「TYPE_NIELSEN_AUDIENCE_PROFILE」
  • 「TYPE_NIELSEN_DAILY_REACH_BUILD」
  • 「TYPE_NIELSEN_ONLINE_GLOBAL_MARKET」
  • 「TYPE_NIELSEN_SITE」
  • 「TYPE_NOT_SUPPORTED」
  • 「TYPE_ORDER_ID」
  • 「TYPE_PAGE_CATEGORY」
  • 「TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE」
  • 「TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD」
  • 「TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET」
  • 「TYPE_PIXEL_LOAD」
  • 「TYPE_REACH_AND_FREQUENCY」
  • 「TYPE_REACH_AUDIENCE」
  • 「TYPE_THIRD_PARTY_DATA_PROVIDER」
  • 「TYPE_TRUEVIEW」
  • 「TYPE_TRUEVIEW_IAR」
  • 「TYPE_VERIFICATION」
  • 「TYPE_YOUTUBE_VERTICAL」

Methods

リストレポート
保存されているレポートを取得します。