Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.

Scopes

You will need authorization for the https://www.googleapis.com/auth/dfareporting scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/dfareporting. You can set the scope for this method like this: dfareporting3 --scope <scope> reports compatible-fields-query ...

Required Scalar Argument

  • <profile-id> (string)
    • The DFA user profile ID.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Report:
  account-id: string
  criteria:
    activities:
      kind: string
      metric-names: [string]
    custom-rich-media-events:
      kind: string
    date-range:
      end-date: string
      kind: string
      relative-date-range: string
      start-date: string
    metric-names: [string]
  cross-dimension-reach-criteria:
    date-range:
      end-date: string
      kind: string
      relative-date-range: string
      start-date: string
    dimension: string
    metric-names: [string]
    overlap-metric-names: [string]
    pivoted: boolean
  delivery:
    email-owner: boolean
    email-owner-delivery-type: string
    message: string
  etag: string
  file-name: string
  floodlight-criteria:
    date-range:
      end-date: string
      kind: string
      relative-date-range: string
      start-date: string
    floodlight-config-id:
      dimension-name: string
      etag: string
      id: string
      kind: string
      match-type: string
      value: string
    metric-names: [string]
    report-properties:
      include-attributed-ip-conversions: boolean
      include-unattributed-cookie-conversions: boolean
      include-unattributed-ip-conversions: boolean
  format: string
  id: string
  kind: string
  last-modified-time: string
  name: string
  owner-profile-id: string
  path-to-conversion-criteria:
    date-range:
      end-date: string
      kind: string
      relative-date-range: string
      start-date: string
    floodlight-config-id:
      dimension-name: string
      etag: string
      id: string
      kind: string
      match-type: string
      value: string
    metric-names: [string]
    report-properties:
      clicks-lookback-window: integer
      impressions-lookback-window: integer
      include-attributed-ip-conversions: boolean
      include-unattributed-cookie-conversions: boolean
      include-unattributed-ip-conversions: boolean
      maximum-click-interactions: integer
      maximum-impression-interactions: integer
      maximum-interaction-gap: integer
      pivot-on-interaction-path: boolean
  reach-criteria:
    activities:
      kind: string
      metric-names: [string]
    custom-rich-media-events:
      kind: string
    date-range:
      end-date: string
      kind: string
      relative-date-range: string
      start-date: string
    enable-all-dimension-combinations: boolean
    metric-names: [string]
    reach-by-frequency-metric-names: [string]
  schedule:
    active: boolean
    every: integer
    expiration-date: string
    repeats: string
    repeats-on-week-days: [string]
    runs-on-day-of-month: string
    start-date: string
  sub-account-id: string
  type: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . account-id=sea
    • The account ID to which this report belongs.
  • criteria.activities kind=sea
    • The kind of resource this is, in this case dfareporting#activities.

  • metric-names=duo

    • List of names of floodlight activity metrics.
    • Each invocation of this argument appends the given value to the array.

  • ..custom-rich-media-events kind=consetetur

    • The kind of resource this is, in this case dfareporting#customRichMediaEvents.

  • ..date-range end-date=rebum.

    • The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
  • kind=dolores
    • The kind of resource this is, in this case dfareporting#dateRange.
  • relative-date-range=stet
    • The date range relative to the date of when the report is run.

  • start-date=eirmod

    • The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".

  • .. metric-names=lorem

    • The list of names of metrics the report should include.
    • Each invocation of this argument appends the given value to the array.

  • ..cross-dimension-reach-criteria.date-range end-date=dolor

    • The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
  • kind=sanctus
    • The kind of resource this is, in this case dfareporting#dateRange.
  • relative-date-range=et
    • The date range relative to the date of when the report is run.

  • start-date=et

    • The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".

  • .. dimension=rebum.

    • The dimension option.
  • metric-names=invidunt
    • The list of names of metrics the report should include.
    • Each invocation of this argument appends the given value to the array.
  • overlap-metric-names=sea
    • The list of names of overlap metrics the report should include.
    • Each invocation of this argument appends the given value to the array.

  • pivoted=true

    • Whether the report is pivoted or not. Defaults to true.

  • ..delivery email-owner=true

    • Whether the report should be emailed to the report owner.
  • email-owner-delivery-type=dolor
    • The type of delivery for the owner to receive, if enabled.

  • message=ipsum

    • The message to be sent with each email.

  • .. etag=accusam

    • The eTag of this response for caching purposes.
  • file-name=at
    • The filename used when generating report files for this report.
  • floodlight-criteria.date-range end-date=sadipscing
    • The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
  • kind=amet.
    • The kind of resource this is, in this case dfareporting#dateRange.
  • relative-date-range=sanctus
    • The date range relative to the date of when the report is run.

  • start-date=aliquyam

    • The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".

  • ..floodlight-config-id dimension-name=labore

    • The name of the dimension.
  • etag=diam
    • The eTag of this response for caching purposes.
  • id=justo
    • The ID associated with the value if available.
  • kind=ea
    • The kind of resource this is, in this case dfareporting#dimensionValue.
  • match-type=ut
    • Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT.

  • value=voluptua.

    • The value of the dimension.

  • .. metric-names=amet.

    • The list of names of metrics the report should include.
    • Each invocation of this argument appends the given value to the array.
  • report-properties include-attributed-ip-conversions=false
    • Include conversions that have no cookie, but do have an exposure path.
  • include-unattributed-cookie-conversions=true
    • Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.

  • include-unattributed-ip-conversions=true

    • Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.

  • ... format=est

    • The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
  • id=ipsum
    • The unique ID identifying this report resource.
  • kind=gubergren
    • The kind of resource this is, in this case dfareporting#report.
  • last-modified-time=et
    • The timestamp (in milliseconds since epoch) of when this report was last modified.
  • name=gubergren
    • The name of the report.
  • owner-profile-id=erat
    • The user profile id of the owner of this report.
  • path-to-conversion-criteria.date-range end-date=aliquyam
    • The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
  • kind=ut
    • The kind of resource this is, in this case dfareporting#dateRange.
  • relative-date-range=tempor
    • The date range relative to the date of when the report is run.

  • start-date=dolore

    • The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".

  • ..floodlight-config-id dimension-name=elitr

    • The name of the dimension.
  • etag=nonumy
    • The eTag of this response for caching purposes.
  • id=erat
    • The ID associated with the value if available.
  • kind=diam
    • The kind of resource this is, in this case dfareporting#dimensionValue.
  • match-type=sed
    • Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT.

  • value=dolor

    • The value of the dimension.

  • .. metric-names=sed

    • The list of names of metrics the report should include.
    • Each invocation of this argument appends the given value to the array.
  • report-properties clicks-lookback-window=60
    • DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
  • impressions-lookback-window=5
    • DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
  • include-attributed-ip-conversions=false
    • Deprecated: has no effect.
  • include-unattributed-cookie-conversions=false
    • Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
  • include-unattributed-ip-conversions=true
    • Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
  • maximum-click-interactions=57
    • The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
  • maximum-impression-interactions=5
    • The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
  • maximum-interaction-gap=30
    • The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.

  • pivot-on-interaction-path=true

    • Enable pivoting on interaction path.

  • ...reach-criteria.activities kind=diam

    • The kind of resource this is, in this case dfareporting#activities.

  • metric-names=dolore

    • List of names of floodlight activity metrics.
    • Each invocation of this argument appends the given value to the array.

  • ..custom-rich-media-events kind=diam

    • The kind of resource this is, in this case dfareporting#customRichMediaEvents.

  • ..date-range end-date=ea

    • The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
  • kind=kasd
    • The kind of resource this is, in this case dfareporting#dateRange.
  • relative-date-range=sit
    • The date range relative to the date of when the report is run.

  • start-date=dolores

    • The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".

  • .. enable-all-dimension-combinations=false

    • Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.
  • metric-names=et
    • The list of names of metrics the report should include.
    • Each invocation of this argument appends the given value to the array.

  • reach-by-frequency-metric-names=invidunt

    • The list of names of Reach By Frequency metrics the report should include.
    • Each invocation of this argument appends the given value to the array.

  • ..schedule active=false

    • Whether the schedule is active or not. Must be set to either true or false.
  • every=91
    • Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
  • expiration-date=at
    • The expiration date when the scheduled report stops running.
  • repeats=takimata
    • The interval for which the report is repeated. Note:
      • "DAILY" also requires field "every" to be set.
      • "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
      • "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
  • repeats-on-week-days=et
    • List of week days "WEEKLY" on which scheduled reports should run.
    • Each invocation of this argument appends the given value to the array.
  • runs-on-day-of-month=at
    • Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.

  • start-date=et

    • Start date of date range for which scheduled reports should be run.

  • .. sub-account-id=dolores

    • The subaccount ID to which this report belongs if applicable.
  • type=dolores
    • The type of the report.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p alt=string

    • Data format for the response.

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • -p user-ip=string

    • Deprecated. Please use quotaUser instead.