Reports

For a list of methods for this resource, see the end of this page.

Resource representations

Represents a report.

{
  "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,
    "options": {
      "includeOnlyTargetedUserLists": boolean,
      "pathQueryOptions": {
        "channelGrouping": {
          "name": string,
          "rules": [
            {
              "name": string,
              "disjunctiveMatchStatements": [
                {
                  "eventFilters": [
                    {
                      "dimensionFilter": {
                        "filter": string,
                        "match": string,
                        "values": [
                          string
                        ]
                      }
                    }
                  ]
                }
              ]
            }
          ],
          "fallbackName": string
        },
        "pathFilters": [
          {
            "eventFilters": [
              {
                "dimensionFilter": {
                  "filter": string,
                  "match": string,
                  "values": [
                    string
                  ]
                }
              }
            ],
            "pathMatchPosition": string
          }
        ]
      }
    }
  }
}
Property name Value Description Notes
key nested object Key used to identify a report.
key.queryId long Query ID.
key.reportId long Report ID.
metadata nested object Report metadata.
metadata.googleCloudStoragePath string The path to the location in Google Cloud Storage where the report is stored.
metadata.reportDataEndTimeMs long The ending time for the data that is shown in the report.
metadata.reportDataStartTimeMs long The starting time for the data that is shown in the report.
metadata.status nested object Report status.
metadata.status.failure nested object If the report failed, this records the cause.
metadata.status.failure.errorCode string Error code that shows why the report was not created.

Acceptable values are:
  • "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 The time when this report either completed successfully or failed.
metadata.status.format string The file type of the report.

Acceptable values are:
  • "CSV"
  • "EXCEL_CSV"
  • "XLSX"
metadata.status.state string The state of the report.

Acceptable values are:
  • "DONE"
  • "FAILED"
  • "RUNNING"
params nested object Report parameters.
params.filters[] list Filters used to match traffic data in your report.
params.filters[].type string Filter type.

Acceptable values are:
  • "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_ID"
  • "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_NAME"
  • "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY"
  • "FILTER_ADVERTISER"
  • "FILTER_ADVERTISER_CURRENCY"
  • "FILTER_ADVERTISER_INTEGRATION_CODE"
  • "FILTER_ADVERTISER_INTEGRATION_STATUS"
  • "FILTER_ADVERTISER_NAME"
  • "FILTER_ADVERTISER_TIMEZONE"
  • "FILTER_AD_POSITION"
  • "FILTER_AD_TYPE"
  • "FILTER_AGE"
  • "FILTER_ALGORITHM"
  • "FILTER_ALGORITHM_ID"
  • "FILTER_AMP_PAGE_REQUEST"
  • "FILTER_ANONYMOUS_INVENTORY_MODELING"
  • "FILTER_APP_URL"
  • "FILTER_APP_URL_EXCLUDED"
  • "FILTER_ATTRIBUTED_USERLIST"
  • "FILTER_ATTRIBUTED_USERLIST_COST"
  • "FILTER_ATTRIBUTED_USERLIST_TYPE"
  • "FILTER_ATTRIBUTION_MODEL"
  • "FILTER_AUDIENCE_LIST"
  • "FILTER_AUDIENCE_LIST_COST"
  • "FILTER_AUDIENCE_LIST_TYPE"
  • "FILTER_AUDIENCE_NAME"
  • "FILTER_AUDIENCE_TYPE"
  • "FILTER_AUTHORIZED_SELLER_STATE"
  • "FILTER_BILLABLE_OUTCOME"
  • "FILTER_BRAND_LIFT_TYPE"
  • "FILTER_BROWSER"
  • "FILTER_BUDGET_SEGMENT_BUDGET"
  • "FILTER_BUDGET_SEGMENT_DESCRIPTION"
  • "FILTER_BUDGET_SEGMENT_END_DATE"
  • "FILTER_BUDGET_SEGMENT_PACING_PERCENTAGE"
  • "FILTER_BUDGET_SEGMENT_START_DATE"
  • "FILTER_BUDGET_SEGMENT_TYPE"
  • "FILTER_CAMPAIGN_DAILY_FREQUENCY"
  • "FILTER_CARRIER"
  • "FILTER_CARRIER_NAME"
  • "FILTER_CHANNEL_GROUPING"
  • "FILTER_CHANNEL_ID"
  • "FILTER_CHANNEL_NAME"
  • "FILTER_CHANNEL_TYPE"
  • "FILTER_CITY"
  • "FILTER_CITY_NAME"
  • "FILTER_CM360_PLACEMENT_ID"
  • "FILTER_CM_PLACEMENT_ID"
  • "FILTER_COMPANION_CREATIVE_ID"
  • "FILTER_COMPANION_CREATIVE_NAME"
  • "FILTER_CONVERSION_DELAY"
  • "FILTER_CONVERSION_SOURCE"
  • "FILTER_CONVERSION_SOURCE_ID"
  • "FILTER_COUNTRY"
  • "FILTER_COUNTRY_ID"
  • "FILTER_CREATIVE"
  • "FILTER_CREATIVE_ASSET"
  • "FILTER_CREATIVE_ATTRIBUTE"
  • "FILTER_CREATIVE_HEIGHT"
  • "FILTER_CREATIVE_ID"
  • "FILTER_CREATIVE_INTEGRATION_CODE"
  • "FILTER_CREATIVE_RENDERED_IN_AMP"
  • "FILTER_CREATIVE_SIZE"
  • "FILTER_CREATIVE_SOURCE"
  • "FILTER_CREATIVE_STATUS"
  • "FILTER_CREATIVE_TYPE"
  • "FILTER_CREATIVE_WIDTH"
  • "FILTER_DATA_PROVIDER"
  • "FILTER_DATA_PROVIDER_NAME"
  • "FILTER_DATA_SOURCE"
  • "FILTER_DATE"
  • "FILTER_DAY_OF_WEEK"
  • "FILTER_DETAILED_DEMOGRAPHICS"
  • "FILTER_DETAILED_DEMOGRAPHICS_ID"
  • "FILTER_DEVICE"
  • "FILTER_DEVICE_MAKE"
  • "FILTER_DEVICE_MODEL"
  • "FILTER_DEVICE_TYPE"
  • "FILTER_DFP_ORDER_ID"
  • "FILTER_DIGITAL_CONTENT_LABEL"
  • "FILTER_DMA"
  • "FILTER_DMA_NAME"
  • "FILTER_DOMAIN"
  • "FILTER_ELIGIBLE_COOKIES_ON_FIRST_PARTY_AUDIENCE_LIST"
  • "FILTER_ELIGIBLE_COOKIES_ON_THIRD_PARTY_AUDIENCE_LIST_AND_INTEREST"
  • "FILTER_EVENT_TYPE"
  • "FILTER_EXCHANGE"
  • "FILTER_EXCHANGE_CODE"
  • "FILTER_EXCHANGE_ID"
  • "FILTER_EXTENSION"
  • "FILTER_EXTENSION_STATUS"
  • "FILTER_EXTENSION_TYPE"
  • "FILTER_FIRST_PARTY_AUDIENCE_LIST_COST"
  • "FILTER_FIRST_PARTY_AUDIENCE_LIST_TYPE"
  • "FILTER_FLOODLIGHT_ACTIVITY"
  • "FILTER_FLOODLIGHT_ACTIVITY_ID"
  • "FILTER_FORMAT"
  • "FILTER_GAM_INSERTION_ORDER"
  • "FILTER_GAM_LINE_ITEM"
  • "FILTER_GAM_LINE_ITEM_ID"
  • "FILTER_GENDER"
  • "FILTER_GMAIL_AGE"
  • "FILTER_GMAIL_CITY"
  • "FILTER_GMAIL_COUNTRY"
  • "FILTER_GMAIL_COUNTRY_NAME"
  • "FILTER_GMAIL_DEVICE_TYPE"
  • "FILTER_GMAIL_DEVICE_TYPE_NAME"
  • "FILTER_GMAIL_GENDER"
  • "FILTER_GMAIL_REGION"
  • "FILTER_GMAIL_REMARKETING_LIST"
  • "FILTER_HOUSEHOLD_INCOME"
  • "FILTER_IMPRESSION_COUNTING_METHOD"
  • "FILTER_INSERTION_ORDER"
  • "FILTER_INSERTION_ORDER_GOAL_TYPE"
  • "FILTER_INSERTION_ORDER_GOAL_VALUE"
  • "FILTER_INSERTION_ORDER_INTEGRATION_CODE"
  • "FILTER_INSERTION_ORDER_NAME"
  • "FILTER_INSERTION_ORDER_STATUS"
  • "FILTER_INTEREST"
  • "FILTER_INVENTORY_COMMITMENT_TYPE"
  • "FILTER_INVENTORY_DELIVERY_METHOD"
  • "FILTER_INVENTORY_FORMAT"
  • "FILTER_INVENTORY_RATE_TYPE"
  • "FILTER_INVENTORY_SOURCE"
  • "FILTER_INVENTORY_SOURCE_EXTERNAL_ID"
  • "FILTER_INVENTORY_SOURCE_GROUP"
  • "FILTER_INVENTORY_SOURCE_GROUP_ID"
  • "FILTER_INVENTORY_SOURCE_ID"
  • "FILTER_INVENTORY_SOURCE_NAME"
  • "FILTER_INVENTORY_SOURCE_TYPE"
  • "FILTER_KEYWORD"
  • "FILTER_LIFE_EVENT"
  • "FILTER_LIFE_EVENTS"
  • "FILTER_LINE_ITEM"
  • "FILTER_LINE_ITEM_BUDGET"
  • "FILTER_LINE_ITEM_DAILY_FREQUENCY"
  • "FILTER_LINE_ITEM_END_DATE"
  • "FILTER_LINE_ITEM_INTEGRATION_CODE"
  • "FILTER_LINE_ITEM_LIFETIME_FREQUENCY"
  • "FILTER_LINE_ITEM_NAME"
  • "FILTER_LINE_ITEM_PACING_PERCENTAGE"
  • "FILTER_LINE_ITEM_START_DATE"
  • "FILTER_LINE_ITEM_STATUS"
  • "FILTER_LINE_ITEM_TYPE"
  • "FILTER_MATCHED_GENRE_TARGET"
  • "FILTER_MATCH_RATIO"
  • "FILTER_MEASUREMENT_SOURCE"
  • "FILTER_MEDIA_PLAN"
  • "FILTER_MEDIA_PLAN_NAME"
  • "FILTER_MOBILE_GEO"
  • "FILTER_MONTH"
  • "FILTER_MRAID_SUPPORT"
  • "FILTER_NIELSEN_AGE"
  • "FILTER_NIELSEN_COUNTRY_CODE"
  • "FILTER_NIELSEN_DATE_RANGE"
  • "FILTER_NIELSEN_DEVICE_ID"
  • "FILTER_NIELSEN_GENDER"
  • "FILTER_NIELSEN_RESTATEMENT_DATE"
  • "FILTER_NOT_SUPPORTED"
  • "FILTER_OMID_CAPABLE"
  • "FILTER_OM_SDK_AVAILABLE"
  • "FILTER_ORDER_ID"
  • "FILTER_OS"
  • "FILTER_PAGE_CATEGORY"
  • "FILTER_PAGE_LAYOUT"
  • "FILTER_PARENTAL_STATUS"
  • "FILTER_PARTNER"
  • "FILTER_PARTNER_CURRENCY"
  • "FILTER_PARTNER_NAME"
  • "FILTER_PARTNER_STATUS"
  • "FILTER_PATH_EVENT_INDEX"
  • "FILTER_PATH_PATTERN_ID"
  • "FILTER_PLACEMENT_ALL_YOUTUBE_CHANNELS"
  • "FILTER_PLACEMENT_NAME_ALL_YOUTUBE_CHANNELS"
  • "FILTER_PLATFORM"
  • "FILTER_PLAYBACK_METHOD"
  • "FILTER_POSITION_IN_CONTENT"
  • "FILTER_PUBLIC_INVENTORY"
  • "FILTER_PUBLISHER_PROPERTY"
  • "FILTER_PUBLISHER_PROPERTY_ID"
  • "FILTER_PUBLISHER_PROPERTY_SECTION"
  • "FILTER_PUBLISHER_PROPERTY_SECTION_ID"
  • "FILTER_QUARTER"
  • "FILTER_REFUND_REASON"
  • "FILTER_REGION"
  • "FILTER_REGION_NAME"
  • "FILTER_REMARKETING_LIST"
  • "FILTER_REWARDED"
  • "FILTER_SENSITIVE_CATEGORY"
  • "FILTER_SERVED_PIXEL_DENSITY"
  • "FILTER_SITE_ID"
  • "FILTER_SITE_LANGUAGE"
  • "FILTER_SKIPPABLE_SUPPORT"
  • "FILTER_TARGETED_DATA_PROVIDERS"
  • "FILTER_TARGETED_USER_LIST"
  • "FILTER_THIRD_PARTY_AUDIENCE_LIST_COST"
  • "FILTER_THIRD_PARTY_AUDIENCE_LIST_TYPE"
  • "FILTER_TIME_OF_DAY"
  • "FILTER_TRUEVIEW_AD"
  • "FILTER_TRUEVIEW_AD_GROUP"
  • "FILTER_TRUEVIEW_AD_GROUP_AD_ID"
  • "FILTER_TRUEVIEW_AD_GROUP_ID"
  • "FILTER_TRUEVIEW_AD_TYPE_NAME"
  • "FILTER_TRUEVIEW_AGE"
  • "FILTER_TRUEVIEW_CATEGORY"
  • "FILTER_TRUEVIEW_CITY"
  • "FILTER_TRUEVIEW_CLICK_TYPE_NAME"
  • "FILTER_TRUEVIEW_CONVERSION_TYPE"
  • "FILTER_TRUEVIEW_COUNTRY"
  • "FILTER_TRUEVIEW_CUSTOM_AFFINITY"
  • "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS"
  • "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS_ID"
  • "FILTER_TRUEVIEW_DMA"
  • "FILTER_TRUEVIEW_DMA_NAME"
  • "FILTER_TRUEVIEW_GENDER"
  • "FILTER_TRUEVIEW_HOUSEHOLD_INCOME"
  • "FILTER_TRUEVIEW_IAR_AGE"
  • "FILTER_TRUEVIEW_IAR_CATEGORY"
  • "FILTER_TRUEVIEW_IAR_CITY"
  • "FILTER_TRUEVIEW_IAR_COUNTRY"
  • "FILTER_TRUEVIEW_IAR_COUNTRY_NAME"
  • "FILTER_TRUEVIEW_IAR_GENDER"
  • "FILTER_TRUEVIEW_IAR_INTEREST"
  • "FILTER_TRUEVIEW_IAR_LANGUAGE"
  • "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS"
  • "FILTER_TRUEVIEW_IAR_REGION"
  • "FILTER_TRUEVIEW_IAR_REGION_NAME"
  • "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_PLACEMENT_ID"
  • "FILTER_TRUEVIEW_REGION"
  • "FILTER_TRUEVIEW_REGION_NAME"
  • "FILTER_TRUEVIEW_REMARKETING_LIST"
  • "FILTER_TRUEVIEW_REMARKETING_LIST_NAME"
  • "FILTER_TRUEVIEW_URL"
  • "FILTER_TRUEVIEW_ZIPCODE"
  • "FILTER_UNKNOWN"
  • "FILTER_USER_LIST"
  • "FILTER_USER_LIST_FIRST_PARTY"
  • "FILTER_USER_LIST_FIRST_PARTY_NAME"
  • "FILTER_USER_LIST_THIRD_PARTY"
  • "FILTER_USER_LIST_THIRD_PARTY_NAME"
  • "FILTER_VARIANT_ID"
  • "FILTER_VARIANT_NAME"
  • "FILTER_VARIANT_VERSION"
  • "FILTER_VERIFICATION_VIDEO_PLAYER_SIZE"
  • "FILTER_VERIFICATION_VIDEO_POSITION"
  • "FILTER_VIDEO_AD_POSITION_IN_STREAM"
  • "FILTER_VIDEO_COMPANION_CREATIVE_SIZE"
  • "FILTER_VIDEO_CONTENT_DURATION"
  • "FILTER_VIDEO_CONTENT_LIVE_STREAM"
  • "FILTER_VIDEO_CONTINUOUS_PLAY"
  • "FILTER_VIDEO_CREATIVE_DURATION"
  • "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE"
  • "FILTER_VIDEO_DURATION"
  • "FILTER_VIDEO_DURATION_SECONDS"
  • "FILTER_VIDEO_DURATION_SECONDS_RANGE"
  • "FILTER_VIDEO_FORMAT_SUPPORT"
  • "FILTER_VIDEO_PLAYER_SIZE"
  • "FILTER_VIDEO_RATING_TIER"
  • "FILTER_VIDEO_SKIPPABLE_SUPPORT"
  • "FILTER_WEEK"
  • "FILTER_YEAR"
  • "FILTER_YOUTUBE_ADAPTED_AUDIENCE_LIST"
  • "FILTER_YOUTUBE_AD_VIDEO"
  • "FILTER_YOUTUBE_AD_VIDEO_ID"
  • "FILTER_YOUTUBE_CHANNEL"
  • "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_ADVERTISER"
  • "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_INSERTION_ORDER"
  • "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_PARTNER"
  • "FILTER_YOUTUBE_VIDEO"
  • "FILTER_ZIP_CODE"
  • "FILTER_ZIP_POSTAL_CODE"
params.filters[].value string Filter value.
params.groupBys[] list Data is grouped by the filters listed in this field.
params.includeInviteData boolean Deprecated. This field is no longer in use.
params.metrics[] list Metrics to include as columns in your report.
params.options nested object Additional query options.
params.options.includeOnlyTargetedUserLists boolean Whether to only include data for audience lists specifically targeted by insertion orders or line items. Only applicable for TYPE_GENERAL reports. FILTER_AUDIENCE_LIST must be included as a filter or dimension. Either FILTER_INSERTION_ORDER or FILTER_LINE_ITEM must be included as a filter.
params.options.pathQueryOptions nested object Options that contain Path Filters and Custom Channel Groupings. Only applicable for TYPE_PATH and TYPE_PATH_ATTRIBUTION reports.
params.options.pathQueryOptions.channelGrouping nested object Custom Channel Groupings. Only applicable for TYPE_PATH and TYPE_PATH_ATTRIBUTION reports.
params.options.pathQueryOptions.channelGrouping.fallbackName string The name to apply to an event that does not match any of the rules in the channel grouping.
params.options.pathQueryOptions.channelGrouping.name string Channel Grouping name.
params.options.pathQueryOptions.channelGrouping.rules[] list Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[] list DisjunctiveMatchStatements within a Rule. DisjunctiveMatchStatement OR's all contained filters.
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] list Filters. There is a limit of 100 filters that can be set per disjunctive match statement.
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter nested object Filter on a dimension.
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.filter string Dimension the filter is applied to.

Acceptable values are:
  • "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_ID"
  • "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_NAME"
  • "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY"
  • "FILTER_ADVERTISER"
  • "FILTER_ADVERTISER_CURRENCY"
  • "FILTER_ADVERTISER_INTEGRATION_CODE"
  • "FILTER_ADVERTISER_INTEGRATION_STATUS"
  • "FILTER_ADVERTISER_NAME"
  • "FILTER_ADVERTISER_TIMEZONE"
  • "FILTER_AD_POSITION"
  • "FILTER_AD_TYPE"
  • "FILTER_AGE"
  • "FILTER_ALGORITHM"
  • "FILTER_ALGORITHM_ID"
  • "FILTER_AMP_PAGE_REQUEST"
  • "FILTER_ANONYMOUS_INVENTORY_MODELING"
  • "FILTER_APP_URL"
  • "FILTER_APP_URL_EXCLUDED"
  • "FILTER_ATTRIBUTED_USERLIST"
  • "FILTER_ATTRIBUTED_USERLIST_COST"
  • "FILTER_ATTRIBUTED_USERLIST_TYPE"
  • "FILTER_ATTRIBUTION_MODEL"
  • "FILTER_AUDIENCE_LIST"
  • "FILTER_AUDIENCE_LIST_COST"
  • "FILTER_AUDIENCE_LIST_TYPE"
  • "FILTER_AUDIENCE_NAME"
  • "FILTER_AUDIENCE_TYPE"
  • "FILTER_AUTHORIZED_SELLER_STATE"
  • "FILTER_BILLABLE_OUTCOME"
  • "FILTER_BRAND_LIFT_TYPE"
  • "FILTER_BROWSER"
  • "FILTER_BUDGET_SEGMENT_BUDGET"
  • "FILTER_BUDGET_SEGMENT_DESCRIPTION"
  • "FILTER_BUDGET_SEGMENT_END_DATE"
  • "FILTER_BUDGET_SEGMENT_PACING_PERCENTAGE"
  • "FILTER_BUDGET_SEGMENT_START_DATE"
  • "FILTER_BUDGET_SEGMENT_TYPE"
  • "FILTER_CAMPAIGN_DAILY_FREQUENCY"
  • "FILTER_CARRIER"
  • "FILTER_CARRIER_NAME"
  • "FILTER_CHANNEL_GROUPING"
  • "FILTER_CHANNEL_ID"
  • "FILTER_CHANNEL_NAME"
  • "FILTER_CHANNEL_TYPE"
  • "FILTER_CITY"
  • "FILTER_CITY_NAME"
  • "FILTER_CM360_PLACEMENT_ID"
  • "FILTER_CM_PLACEMENT_ID"
  • "FILTER_COMPANION_CREATIVE_ID"
  • "FILTER_COMPANION_CREATIVE_NAME"
  • "FILTER_CONVERSION_DELAY"
  • "FILTER_CONVERSION_SOURCE"
  • "FILTER_CONVERSION_SOURCE_ID"
  • "FILTER_COUNTRY"
  • "FILTER_COUNTRY_ID"
  • "FILTER_CREATIVE"
  • "FILTER_CREATIVE_ASSET"
  • "FILTER_CREATIVE_ATTRIBUTE"
  • "FILTER_CREATIVE_HEIGHT"
  • "FILTER_CREATIVE_ID"
  • "FILTER_CREATIVE_INTEGRATION_CODE"
  • "FILTER_CREATIVE_RENDERED_IN_AMP"
  • "FILTER_CREATIVE_SIZE"
  • "FILTER_CREATIVE_SOURCE"
  • "FILTER_CREATIVE_STATUS"
  • "FILTER_CREATIVE_TYPE"
  • "FILTER_CREATIVE_WIDTH"
  • "FILTER_DATA_PROVIDER"
  • "FILTER_DATA_PROVIDER_NAME"
  • "FILTER_DATA_SOURCE"
  • "FILTER_DATE"
  • "FILTER_DAY_OF_WEEK"
  • "FILTER_DETAILED_DEMOGRAPHICS"
  • "FILTER_DETAILED_DEMOGRAPHICS_ID"
  • "FILTER_DEVICE"
  • "FILTER_DEVICE_MAKE"
  • "FILTER_DEVICE_MODEL"
  • "FILTER_DEVICE_TYPE"
  • "FILTER_DFP_ORDER_ID"
  • "FILTER_DIGITAL_CONTENT_LABEL"
  • "FILTER_DMA"
  • "FILTER_DMA_NAME"
  • "FILTER_DOMAIN"
  • "FILTER_ELIGIBLE_COOKIES_ON_FIRST_PARTY_AUDIENCE_LIST"
  • "FILTER_ELIGIBLE_COOKIES_ON_THIRD_PARTY_AUDIENCE_LIST_AND_INTEREST"
  • "FILTER_EVENT_TYPE"
  • "FILTER_EXCHANGE"
  • "FILTER_EXCHANGE_CODE"
  • "FILTER_EXCHANGE_ID"
  • "FILTER_EXTENSION"
  • "FILTER_EXTENSION_STATUS"
  • "FILTER_EXTENSION_TYPE"
  • "FILTER_FIRST_PARTY_AUDIENCE_LIST_COST"
  • "FILTER_FIRST_PARTY_AUDIENCE_LIST_TYPE"
  • "FILTER_FLOODLIGHT_ACTIVITY"
  • "FILTER_FLOODLIGHT_ACTIVITY_ID"
  • "FILTER_FORMAT"
  • "FILTER_GAM_INSERTION_ORDER"
  • "FILTER_GAM_LINE_ITEM"
  • "FILTER_GAM_LINE_ITEM_ID"
  • "FILTER_GENDER"
  • "FILTER_GMAIL_AGE"
  • "FILTER_GMAIL_CITY"
  • "FILTER_GMAIL_COUNTRY"
  • "FILTER_GMAIL_COUNTRY_NAME"
  • "FILTER_GMAIL_DEVICE_TYPE"
  • "FILTER_GMAIL_DEVICE_TYPE_NAME"
  • "FILTER_GMAIL_GENDER"
  • "FILTER_GMAIL_REGION"
  • "FILTER_GMAIL_REMARKETING_LIST"
  • "FILTER_HOUSEHOLD_INCOME"
  • "FILTER_IMPRESSION_COUNTING_METHOD"
  • "FILTER_INSERTION_ORDER"
  • "FILTER_INSERTION_ORDER_GOAL_TYPE"
  • "FILTER_INSERTION_ORDER_GOAL_VALUE"
  • "FILTER_INSERTION_ORDER_INTEGRATION_CODE"
  • "FILTER_INSERTION_ORDER_NAME"
  • "FILTER_INSERTION_ORDER_STATUS"
  • "FILTER_INTEREST"
  • "FILTER_INVENTORY_COMMITMENT_TYPE"
  • "FILTER_INVENTORY_DELIVERY_METHOD"
  • "FILTER_INVENTORY_FORMAT"
  • "FILTER_INVENTORY_RATE_TYPE"
  • "FILTER_INVENTORY_SOURCE"
  • "FILTER_INVENTORY_SOURCE_EXTERNAL_ID"
  • "FILTER_INVENTORY_SOURCE_GROUP"
  • "FILTER_INVENTORY_SOURCE_GROUP_ID"
  • "FILTER_INVENTORY_SOURCE_ID"
  • "FILTER_INVENTORY_SOURCE_NAME"
  • "FILTER_INVENTORY_SOURCE_TYPE"
  • "FILTER_KEYWORD"
  • "FILTER_LIFE_EVENT"
  • "FILTER_LIFE_EVENTS"
  • "FILTER_LINE_ITEM"
  • "FILTER_LINE_ITEM_BUDGET"
  • "FILTER_LINE_ITEM_DAILY_FREQUENCY"
  • "FILTER_LINE_ITEM_END_DATE"
  • "FILTER_LINE_ITEM_INTEGRATION_CODE"
  • "FILTER_LINE_ITEM_LIFETIME_FREQUENCY"
  • "FILTER_LINE_ITEM_NAME"
  • "FILTER_LINE_ITEM_PACING_PERCENTAGE"
  • "FILTER_LINE_ITEM_START_DATE"
  • "FILTER_LINE_ITEM_STATUS"
  • "FILTER_LINE_ITEM_TYPE"
  • "FILTER_MATCHED_GENRE_TARGET"
  • "FILTER_MATCH_RATIO"
  • "FILTER_MEASUREMENT_SOURCE"
  • "FILTER_MEDIA_PLAN"
  • "FILTER_MEDIA_PLAN_NAME"
  • "FILTER_MOBILE_GEO"
  • "FILTER_MONTH"
  • "FILTER_MRAID_SUPPORT"
  • "FILTER_NIELSEN_AGE"
  • "FILTER_NIELSEN_COUNTRY_CODE"
  • "FILTER_NIELSEN_DATE_RANGE"
  • "FILTER_NIELSEN_DEVICE_ID"
  • "FILTER_NIELSEN_GENDER"
  • "FILTER_NIELSEN_RESTATEMENT_DATE"
  • "FILTER_NOT_SUPPORTED"
  • "FILTER_OMID_CAPABLE"
  • "FILTER_OM_SDK_AVAILABLE"
  • "FILTER_ORDER_ID"
  • "FILTER_OS"
  • "FILTER_PAGE_CATEGORY"
  • "FILTER_PAGE_LAYOUT"
  • "FILTER_PARENTAL_STATUS"
  • "FILTER_PARTNER"
  • "FILTER_PARTNER_CURRENCY"
  • "FILTER_PARTNER_NAME"
  • "FILTER_PARTNER_STATUS"
  • "FILTER_PATH_EVENT_INDEX"
  • "FILTER_PATH_PATTERN_ID"
  • "FILTER_PLACEMENT_ALL_YOUTUBE_CHANNELS"
  • "FILTER_PLACEMENT_NAME_ALL_YOUTUBE_CHANNELS"
  • "FILTER_PLATFORM"
  • "FILTER_PLAYBACK_METHOD"
  • "FILTER_POSITION_IN_CONTENT"
  • "FILTER_PUBLIC_INVENTORY"
  • "FILTER_PUBLISHER_PROPERTY"
  • "FILTER_PUBLISHER_PROPERTY_ID"
  • "FILTER_PUBLISHER_PROPERTY_SECTION"
  • "FILTER_PUBLISHER_PROPERTY_SECTION_ID"
  • "FILTER_QUARTER"
  • "FILTER_REFUND_REASON"
  • "FILTER_REGION"
  • "FILTER_REGION_NAME"
  • "FILTER_REMARKETING_LIST"
  • "FILTER_REWARDED"
  • "FILTER_SENSITIVE_CATEGORY"
  • "FILTER_SERVED_PIXEL_DENSITY"
  • "FILTER_SITE_ID"
  • "FILTER_SITE_LANGUAGE"
  • "FILTER_SKIPPABLE_SUPPORT"
  • "FILTER_TARGETED_DATA_PROVIDERS"
  • "FILTER_TARGETED_USER_LIST"
  • "FILTER_THIRD_PARTY_AUDIENCE_LIST_COST"
  • "FILTER_THIRD_PARTY_AUDIENCE_LIST_TYPE"
  • "FILTER_TIME_OF_DAY"
  • "FILTER_TRUEVIEW_AD"
  • "FILTER_TRUEVIEW_AD_GROUP"
  • "FILTER_TRUEVIEW_AD_GROUP_AD_ID"
  • "FILTER_TRUEVIEW_AD_GROUP_ID"
  • "FILTER_TRUEVIEW_AD_TYPE_NAME"
  • "FILTER_TRUEVIEW_AGE"
  • "FILTER_TRUEVIEW_CATEGORY"
  • "FILTER_TRUEVIEW_CITY"
  • "FILTER_TRUEVIEW_CLICK_TYPE_NAME"
  • "FILTER_TRUEVIEW_CONVERSION_TYPE"
  • "FILTER_TRUEVIEW_COUNTRY"
  • "FILTER_TRUEVIEW_CUSTOM_AFFINITY"
  • "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS"
  • "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS_ID"
  • "FILTER_TRUEVIEW_DMA"
  • "FILTER_TRUEVIEW_DMA_NAME"
  • "FILTER_TRUEVIEW_GENDER"
  • "FILTER_TRUEVIEW_HOUSEHOLD_INCOME"
  • "FILTER_TRUEVIEW_IAR_AGE"
  • "FILTER_TRUEVIEW_IAR_CATEGORY"
  • "FILTER_TRUEVIEW_IAR_CITY"
  • "FILTER_TRUEVIEW_IAR_COUNTRY"
  • "FILTER_TRUEVIEW_IAR_COUNTRY_NAME"
  • "FILTER_TRUEVIEW_IAR_GENDER"
  • "FILTER_TRUEVIEW_IAR_INTEREST"
  • "FILTER_TRUEVIEW_IAR_LANGUAGE"
  • "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS"
  • "FILTER_TRUEVIEW_IAR_REGION"
  • "FILTER_TRUEVIEW_IAR_REGION_NAME"
  • "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_PLACEMENT_ID"
  • "FILTER_TRUEVIEW_REGION"
  • "FILTER_TRUEVIEW_REGION_NAME"
  • "FILTER_TRUEVIEW_REMARKETING_LIST"
  • "FILTER_TRUEVIEW_REMARKETING_LIST_NAME"
  • "FILTER_TRUEVIEW_URL"
  • "FILTER_TRUEVIEW_ZIPCODE"
  • "FILTER_UNKNOWN"
  • "FILTER_USER_LIST"
  • "FILTER_USER_LIST_FIRST_PARTY"
  • "FILTER_USER_LIST_FIRST_PARTY_NAME"
  • "FILTER_USER_LIST_THIRD_PARTY"
  • "FILTER_USER_LIST_THIRD_PARTY_NAME"
  • "FILTER_VARIANT_ID"
  • "FILTER_VARIANT_NAME"
  • "FILTER_VARIANT_VERSION"
  • "FILTER_VERIFICATION_VIDEO_PLAYER_SIZE"
  • "FILTER_VERIFICATION_VIDEO_POSITION"
  • "FILTER_VIDEO_AD_POSITION_IN_STREAM"
  • "FILTER_VIDEO_COMPANION_CREATIVE_SIZE"
  • "FILTER_VIDEO_CONTENT_DURATION"
  • "FILTER_VIDEO_CONTENT_LIVE_STREAM"
  • "FILTER_VIDEO_CONTINUOUS_PLAY"
  • "FILTER_VIDEO_CREATIVE_DURATION"
  • "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE"
  • "FILTER_VIDEO_DURATION"
  • "FILTER_VIDEO_DURATION_SECONDS"
  • "FILTER_VIDEO_DURATION_SECONDS_RANGE"
  • "FILTER_VIDEO_FORMAT_SUPPORT"
  • "FILTER_VIDEO_PLAYER_SIZE"
  • "FILTER_VIDEO_RATING_TIER"
  • "FILTER_VIDEO_SKIPPABLE_SUPPORT"
  • "FILTER_WEEK"
  • "FILTER_YEAR"
  • "FILTER_YOUTUBE_ADAPTED_AUDIENCE_LIST"
  • "FILTER_YOUTUBE_AD_VIDEO"
  • "FILTER_YOUTUBE_AD_VIDEO_ID"
  • "FILTER_YOUTUBE_CHANNEL"
  • "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_ADVERTISER"
  • "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_INSERTION_ORDER"
  • "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_PARTNER"
  • "FILTER_YOUTUBE_VIDEO"
  • "FILTER_ZIP_CODE"
  • "FILTER_ZIP_POSTAL_CODE"
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match string Indicates how the filter should be matched to the value.

Acceptable values are:
  • "BEGINS_WITH"
  • "EXACT"
  • "PARTIAL"
  • "UNKNOWN"
  • "WILDCARD_EXPRESSION"
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.values[] list Value to filter on.
params.options.pathQueryOptions.channelGrouping.rules[].name string Rule name.
params.options.pathQueryOptions.pathFilters[] list Path Filters. There is a limit of 100 path filters that can be set per report. Only applicable for TYPE_PATH and TYPE_PATH_ATTRIBUTION reports.
params.options.pathQueryOptions.pathFilters[].eventFilters[] list Filter on an event to be applied to some part of the path.
params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter nested object Filter on a dimension.
params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.filter string Dimension the filter is applied to.

Acceptable values are:
  • "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_ID"
  • "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_NAME"
  • "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY"
  • "FILTER_ADVERTISER"
  • "FILTER_ADVERTISER_CURRENCY"
  • "FILTER_ADVERTISER_INTEGRATION_CODE"
  • "FILTER_ADVERTISER_INTEGRATION_STATUS"
  • "FILTER_ADVERTISER_NAME"
  • "FILTER_ADVERTISER_TIMEZONE"
  • "FILTER_AD_POSITION"
  • "FILTER_AD_TYPE"
  • "FILTER_AGE"
  • "FILTER_ALGORITHM"
  • "FILTER_ALGORITHM_ID"
  • "FILTER_AMP_PAGE_REQUEST"
  • "FILTER_ANONYMOUS_INVENTORY_MODELING"
  • "FILTER_APP_URL"
  • "FILTER_APP_URL_EXCLUDED"
  • "FILTER_ATTRIBUTED_USERLIST"
  • "FILTER_ATTRIBUTED_USERLIST_COST"
  • "FILTER_ATTRIBUTED_USERLIST_TYPE"
  • "FILTER_ATTRIBUTION_MODEL"
  • "FILTER_AUDIENCE_LIST"
  • "FILTER_AUDIENCE_LIST_COST"
  • "FILTER_AUDIENCE_LIST_TYPE"
  • "FILTER_AUDIENCE_NAME"
  • "FILTER_AUDIENCE_TYPE"
  • "FILTER_AUTHORIZED_SELLER_STATE"
  • "FILTER_BILLABLE_OUTCOME"
  • "FILTER_BRAND_LIFT_TYPE"
  • "FILTER_BROWSER"
  • "FILTER_BUDGET_SEGMENT_BUDGET"
  • "FILTER_BUDGET_SEGMENT_DESCRIPTION"
  • "FILTER_BUDGET_SEGMENT_END_DATE"
  • "FILTER_BUDGET_SEGMENT_PACING_PERCENTAGE"
  • "FILTER_BUDGET_SEGMENT_START_DATE"
  • "FILTER_BUDGET_SEGMENT_TYPE"
  • "FILTER_CAMPAIGN_DAILY_FREQUENCY"
  • "FILTER_CARRIER"
  • "FILTER_CARRIER_NAME"
  • "FILTER_CHANNEL_GROUPING"
  • "FILTER_CHANNEL_ID"
  • "FILTER_CHANNEL_NAME"
  • "FILTER_CHANNEL_TYPE"
  • "FILTER_CITY"
  • "FILTER_CITY_NAME"
  • "FILTER_CM360_PLACEMENT_ID"
  • "FILTER_CM_PLACEMENT_ID"
  • "FILTER_COMPANION_CREATIVE_ID"
  • "FILTER_COMPANION_CREATIVE_NAME"
  • "FILTER_CONVERSION_DELAY"
  • "FILTER_CONVERSION_SOURCE"
  • "FILTER_CONVERSION_SOURCE_ID"
  • "FILTER_COUNTRY"
  • "FILTER_COUNTRY_ID"
  • "FILTER_CREATIVE"
  • "FILTER_CREATIVE_ASSET"
  • "FILTER_CREATIVE_ATTRIBUTE"
  • "FILTER_CREATIVE_HEIGHT"
  • "FILTER_CREATIVE_ID"
  • "FILTER_CREATIVE_INTEGRATION_CODE"
  • "FILTER_CREATIVE_RENDERED_IN_AMP"
  • "FILTER_CREATIVE_SIZE"
  • "FILTER_CREATIVE_SOURCE"
  • "FILTER_CREATIVE_STATUS"
  • "FILTER_CREATIVE_TYPE"
  • "FILTER_CREATIVE_WIDTH"
  • "FILTER_DATA_PROVIDER"
  • "FILTER_DATA_PROVIDER_NAME"
  • "FILTER_DATA_SOURCE"
  • "FILTER_DATE"
  • "FILTER_DAY_OF_WEEK"
  • "FILTER_DETAILED_DEMOGRAPHICS"
  • "FILTER_DETAILED_DEMOGRAPHICS_ID"
  • "FILTER_DEVICE"
  • "FILTER_DEVICE_MAKE"
  • "FILTER_DEVICE_MODEL"
  • "FILTER_DEVICE_TYPE"
  • "FILTER_DFP_ORDER_ID"
  • "FILTER_DIGITAL_CONTENT_LABEL"
  • "FILTER_DMA"
  • "FILTER_DMA_NAME"
  • "FILTER_DOMAIN"
  • "FILTER_ELIGIBLE_COOKIES_ON_FIRST_PARTY_AUDIENCE_LIST"
  • "FILTER_ELIGIBLE_COOKIES_ON_THIRD_PARTY_AUDIENCE_LIST_AND_INTEREST"
  • "FILTER_EVENT_TYPE"
  • "FILTER_EXCHANGE"
  • "FILTER_EXCHANGE_CODE"
  • "FILTER_EXCHANGE_ID"
  • "FILTER_EXTENSION"
  • "FILTER_EXTENSION_STATUS"
  • "FILTER_EXTENSION_TYPE"
  • "FILTER_FIRST_PARTY_AUDIENCE_LIST_COST"
  • "FILTER_FIRST_PARTY_AUDIENCE_LIST_TYPE"
  • "FILTER_FLOODLIGHT_ACTIVITY"
  • "FILTER_FLOODLIGHT_ACTIVITY_ID"
  • "FILTER_FORMAT"
  • "FILTER_GAM_INSERTION_ORDER"
  • "FILTER_GAM_LINE_ITEM"
  • "FILTER_GAM_LINE_ITEM_ID"
  • "FILTER_GENDER"
  • "FILTER_GMAIL_AGE"
  • "FILTER_GMAIL_CITY"
  • "FILTER_GMAIL_COUNTRY"
  • "FILTER_GMAIL_COUNTRY_NAME"
  • "FILTER_GMAIL_DEVICE_TYPE"
  • "FILTER_GMAIL_DEVICE_TYPE_NAME"
  • "FILTER_GMAIL_GENDER"
  • "FILTER_GMAIL_REGION"
  • "FILTER_GMAIL_REMARKETING_LIST"
  • "FILTER_HOUSEHOLD_INCOME"
  • "FILTER_IMPRESSION_COUNTING_METHOD"
  • "FILTER_INSERTION_ORDER"
  • "FILTER_INSERTION_ORDER_GOAL_TYPE"
  • "FILTER_INSERTION_ORDER_GOAL_VALUE"
  • "FILTER_INSERTION_ORDER_INTEGRATION_CODE"
  • "FILTER_INSERTION_ORDER_NAME"
  • "FILTER_INSERTION_ORDER_STATUS"
  • "FILTER_INTEREST"
  • "FILTER_INVENTORY_COMMITMENT_TYPE"
  • "FILTER_INVENTORY_DELIVERY_METHOD"
  • "FILTER_INVENTORY_FORMAT"
  • "FILTER_INVENTORY_RATE_TYPE"
  • "FILTER_INVENTORY_SOURCE"
  • "FILTER_INVENTORY_SOURCE_EXTERNAL_ID"
  • "FILTER_INVENTORY_SOURCE_GROUP"
  • "FILTER_INVENTORY_SOURCE_GROUP_ID"
  • "FILTER_INVENTORY_SOURCE_ID"
  • "FILTER_INVENTORY_SOURCE_NAME"
  • "FILTER_INVENTORY_SOURCE_TYPE"
  • "FILTER_KEYWORD"
  • "FILTER_LIFE_EVENT"
  • "FILTER_LIFE_EVENTS"
  • "FILTER_LINE_ITEM"
  • "FILTER_LINE_ITEM_BUDGET"
  • "FILTER_LINE_ITEM_DAILY_FREQUENCY"
  • "FILTER_LINE_ITEM_END_DATE"
  • "FILTER_LINE_ITEM_INTEGRATION_CODE"
  • "FILTER_LINE_ITEM_LIFETIME_FREQUENCY"
  • "FILTER_LINE_ITEM_NAME"
  • "FILTER_LINE_ITEM_PACING_PERCENTAGE"
  • "FILTER_LINE_ITEM_START_DATE"
  • "FILTER_LINE_ITEM_STATUS"
  • "FILTER_LINE_ITEM_TYPE"
  • "FILTER_MATCHED_GENRE_TARGET"
  • "FILTER_MATCH_RATIO"
  • "FILTER_MEASUREMENT_SOURCE"
  • "FILTER_MEDIA_PLAN"
  • "FILTER_MEDIA_PLAN_NAME"
  • "FILTER_MOBILE_GEO"
  • "FILTER_MONTH"
  • "FILTER_MRAID_SUPPORT"
  • "FILTER_NIELSEN_AGE"
  • "FILTER_NIELSEN_COUNTRY_CODE"
  • "FILTER_NIELSEN_DATE_RANGE"
  • "FILTER_NIELSEN_DEVICE_ID"
  • "FILTER_NIELSEN_GENDER"
  • "FILTER_NIELSEN_RESTATEMENT_DATE"
  • "FILTER_NOT_SUPPORTED"
  • "FILTER_OMID_CAPABLE"
  • "FILTER_OM_SDK_AVAILABLE"
  • "FILTER_ORDER_ID"
  • "FILTER_OS"
  • "FILTER_PAGE_CATEGORY"
  • "FILTER_PAGE_LAYOUT"
  • "FILTER_PARENTAL_STATUS"
  • "FILTER_PARTNER"
  • "FILTER_PARTNER_CURRENCY"
  • "FILTER_PARTNER_NAME"
  • "FILTER_PARTNER_STATUS"
  • "FILTER_PATH_EVENT_INDEX"
  • "FILTER_PATH_PATTERN_ID"
  • "FILTER_PLACEMENT_ALL_YOUTUBE_CHANNELS"
  • "FILTER_PLACEMENT_NAME_ALL_YOUTUBE_CHANNELS"
  • "FILTER_PLATFORM"
  • "FILTER_PLAYBACK_METHOD"
  • "FILTER_POSITION_IN_CONTENT"
  • "FILTER_PUBLIC_INVENTORY"
  • "FILTER_PUBLISHER_PROPERTY"
  • "FILTER_PUBLISHER_PROPERTY_ID"
  • "FILTER_PUBLISHER_PROPERTY_SECTION"
  • "FILTER_PUBLISHER_PROPERTY_SECTION_ID"
  • "FILTER_QUARTER"
  • "FILTER_REFUND_REASON"
  • "FILTER_REGION"
  • "FILTER_REGION_NAME"
  • "FILTER_REMARKETING_LIST"
  • "FILTER_REWARDED"
  • "FILTER_SENSITIVE_CATEGORY"
  • "FILTER_SERVED_PIXEL_DENSITY"
  • "FILTER_SITE_ID"
  • "FILTER_SITE_LANGUAGE"
  • "FILTER_SKIPPABLE_SUPPORT"
  • "FILTER_TARGETED_DATA_PROVIDERS"
  • "FILTER_TARGETED_USER_LIST"
  • "FILTER_THIRD_PARTY_AUDIENCE_LIST_COST"
  • "FILTER_THIRD_PARTY_AUDIENCE_LIST_TYPE"
  • "FILTER_TIME_OF_DAY"
  • "FILTER_TRUEVIEW_AD"
  • "FILTER_TRUEVIEW_AD_GROUP"
  • "FILTER_TRUEVIEW_AD_GROUP_AD_ID"
  • "FILTER_TRUEVIEW_AD_GROUP_ID"
  • "FILTER_TRUEVIEW_AD_TYPE_NAME"
  • "FILTER_TRUEVIEW_AGE"
  • "FILTER_TRUEVIEW_CATEGORY"
  • "FILTER_TRUEVIEW_CITY"
  • "FILTER_TRUEVIEW_CLICK_TYPE_NAME"
  • "FILTER_TRUEVIEW_CONVERSION_TYPE"
  • "FILTER_TRUEVIEW_COUNTRY"
  • "FILTER_TRUEVIEW_CUSTOM_AFFINITY"
  • "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS"
  • "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS_ID"
  • "FILTER_TRUEVIEW_DMA"
  • "FILTER_TRUEVIEW_DMA_NAME"
  • "FILTER_TRUEVIEW_GENDER"
  • "FILTER_TRUEVIEW_HOUSEHOLD_INCOME"
  • "FILTER_TRUEVIEW_IAR_AGE"
  • "FILTER_TRUEVIEW_IAR_CATEGORY"
  • "FILTER_TRUEVIEW_IAR_CITY"
  • "FILTER_TRUEVIEW_IAR_COUNTRY"
  • "FILTER_TRUEVIEW_IAR_COUNTRY_NAME"
  • "FILTER_TRUEVIEW_IAR_GENDER"
  • "FILTER_TRUEVIEW_IAR_INTEREST"
  • "FILTER_TRUEVIEW_IAR_LANGUAGE"
  • "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS"
  • "FILTER_TRUEVIEW_IAR_REGION"
  • "FILTER_TRUEVIEW_IAR_REGION_NAME"
  • "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_PLACEMENT_ID"
  • "FILTER_TRUEVIEW_REGION"
  • "FILTER_TRUEVIEW_REGION_NAME"
  • "FILTER_TRUEVIEW_REMARKETING_LIST"
  • "FILTER_TRUEVIEW_REMARKETING_LIST_NAME"
  • "FILTER_TRUEVIEW_URL"
  • "FILTER_TRUEVIEW_ZIPCODE"
  • "FILTER_UNKNOWN"
  • "FILTER_USER_LIST"
  • "FILTER_USER_LIST_FIRST_PARTY"
  • "FILTER_USER_LIST_FIRST_PARTY_NAME"
  • "FILTER_USER_LIST_THIRD_PARTY"
  • "FILTER_USER_LIST_THIRD_PARTY_NAME"
  • "FILTER_VARIANT_ID"
  • "FILTER_VARIANT_NAME"
  • "FILTER_VARIANT_VERSION"
  • "FILTER_VERIFICATION_VIDEO_PLAYER_SIZE"
  • "FILTER_VERIFICATION_VIDEO_POSITION"
  • "FILTER_VIDEO_AD_POSITION_IN_STREAM"
  • "FILTER_VIDEO_COMPANION_CREATIVE_SIZE"
  • "FILTER_VIDEO_CONTENT_DURATION"
  • "FILTER_VIDEO_CONTENT_LIVE_STREAM"
  • "FILTER_VIDEO_CONTINUOUS_PLAY"
  • "FILTER_VIDEO_CREATIVE_DURATION"
  • "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE"
  • "FILTER_VIDEO_DURATION"
  • "FILTER_VIDEO_DURATION_SECONDS"
  • "FILTER_VIDEO_DURATION_SECONDS_RANGE"
  • "FILTER_VIDEO_FORMAT_SUPPORT"
  • "FILTER_VIDEO_PLAYER_SIZE"
  • "FILTER_VIDEO_RATING_TIER"
  • "FILTER_VIDEO_SKIPPABLE_SUPPORT"
  • "FILTER_WEEK"
  • "FILTER_YEAR"
  • "FILTER_YOUTUBE_ADAPTED_AUDIENCE_LIST"
  • "FILTER_YOUTUBE_AD_VIDEO"
  • "FILTER_YOUTUBE_AD_VIDEO_ID"
  • "FILTER_YOUTUBE_CHANNEL"
  • "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_ADVERTISER"
  • "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_INSERTION_ORDER"
  • "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_PARTNER"
  • "FILTER_YOUTUBE_VIDEO"
  • "FILTER_ZIP_CODE"
  • "FILTER_ZIP_POSTAL_CODE"
params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match string Indicates how the filter should be matched to the value.

Acceptable values are:
  • "BEGINS_WITH"
  • "EXACT"
  • "PARTIAL"
  • "UNKNOWN"
  • "WILDCARD_EXPRESSION"
params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.values[] list Value to filter on.
params.options.pathQueryOptions.pathFilters[].pathMatchPosition string Indicates the position of the path the filter should match to (first, last, or any event in path).

Acceptable values are:
  • "ANY"
  • "FIRST"
  • "LAST"
params.type string Report type.

Type-specific limitations:
  • TYPE_ORDER_ID supports date ranges at most 60 days in the past.
  • TYPE_AUDIENCE_COMPOSITION, TYPE_INVENTORY_AVAILABILITY, TYPE_TRUEVIEW_IAR support date ranges at most 30 days in the past.


Acceptable values are:
  • "TYPE_ACTIVE_GRP":  Deprecated
  • "TYPE_AUDIENCE_COMPOSITION"
  • "TYPE_AUDIENCE_PERFORMANCE"
  • "TYPE_CLIENT_SAFE"
  • "TYPE_COMSCORE_VCE"
  • "TYPE_CROSS_FEE":  Cross partner fee report.
  • "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_PATH"
  • "TYPE_PATH_ATTRIBUTION"
  • "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

listreports
Retrieves stored reports.