Updates a pretargeting configuration.

Scopes

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

If unset, the scope for this method defaults to https://www.googleapis.com/auth/realtime-bidding. You can set the scope for this method like this: realtimebidding1 --scope <scope> bidders pretargeting-configs-patch ...

Required Scalar Argument

  • <name> (string)
    • Output only. Name of the pretargeting configuration that must follow the pattern bidders/{bidder_account_id}/pretargetingConfigs/{config_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:

PretargetingConfig:
  allowed-user-targeting-modes: [string]
  app-targeting:
    mobile-app-category-targeting:
      excluded-ids: [string]
      included-ids: [string]
    mobile-app-targeting:
      targeting-mode: string
      values: [string]
  billing-id: string
  display-name: string
  excluded-content-label-ids: [string]
  geo-targeting:
    excluded-ids: [string]
    included-ids: [string]
  included-environments: [string]
  included-formats: [string]
  included-languages: [string]
  included-mobile-operating-system-ids: [string]
  included-platforms: [string]
  included-user-id-types: [string]
  interstitial-targeting: string
  invalid-geo-ids: [string]
  maximum-qps: string
  minimum-viewability-decile: integer
  name: string
  publisher-targeting:
    targeting-mode: string
    values: [string]
  state: string
  user-list-targeting:
    excluded-ids: [string]
    included-ids: [string]
  vertical-targeting:
    excluded-ids: [string]
    included-ids: [string]
  web-targeting:
    targeting-mode: string
    values: [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 . allowed-user-targeting-modes=no
    • Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
    • Each invocation of this argument appends the given value to the array.
  • app-targeting.mobile-app-category-targeting excluded-ids=stet
    • The IDs excluded in a configuration.
    • Each invocation of this argument appends the given value to the array.

  • included-ids=kasd

    • The IDs included in a configuration.
    • Each invocation of this argument appends the given value to the array.

  • ..mobile-app-targeting targeting-mode=et

    • How the items in this list should be targeted.

  • values=sed

    • The values specified.
    • Each invocation of this argument appends the given value to the array.

  • ... billing-id=et

    • Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
  • display-name=et
    • The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
  • excluded-content-label-ids=vero
    • The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
    • Each invocation of this argument appends the given value to the array.
  • geo-targeting excluded-ids=erat
    • The IDs excluded in a configuration.
    • Each invocation of this argument appends the given value to the array.

  • included-ids=sed

    • The IDs included in a configuration.
    • Each invocation of this argument appends the given value to the array.

  • .. included-environments=duo

    • Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
    • Each invocation of this argument appends the given value to the array.
  • included-formats=dolore
    • Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
    • Each invocation of this argument appends the given value to the array.
  • included-languages=et
    • The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
    • Each invocation of this argument appends the given value to the array.
  • included-mobile-operating-system-ids=voluptua.
    • The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
    • Each invocation of this argument appends the given value to the array.
  • included-platforms=amet.
    • The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
    • Each invocation of this argument appends the given value to the array.
  • included-user-id-types=consetetur
    • User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
    • Each invocation of this argument appends the given value to the array.
  • interstitial-targeting=diam
    • The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
  • invalid-geo-ids=dolor
    • Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
    • Each invocation of this argument appends the given value to the array.
  • maximum-qps=et
    • The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
  • minimum-viewability-decile=79
    • The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
  • name=sadipscing
    • Output only. Name of the pretargeting configuration that must follow the pattern bidders/{bidder_account_id}/pretargetingConfigs/{config_id}
  • publisher-targeting targeting-mode=stet
    • How the items in this list should be targeted.

  • values=dolor

    • The values specified.
    • Each invocation of this argument appends the given value to the array.

  • .. state=duo

    • Output only. The state of this pretargeting configuration.
  • user-list-targeting excluded-ids=vero
    • The IDs excluded in a configuration.
    • Each invocation of this argument appends the given value to the array.

  • included-ids=vero

    • The IDs included in a configuration.
    • Each invocation of this argument appends the given value to the array.

  • ..vertical-targeting excluded-ids=invidunt

    • The IDs excluded in a configuration.
    • Each invocation of this argument appends the given value to the array.

  • included-ids=stet

    • The IDs included in a configuration.
    • Each invocation of this argument appends the given value to the array.

  • ..web-targeting targeting-mode=vero

    • How the items in this list should be targeted.
  • values=elitr
    • The values specified.
    • Each invocation of this argument appends the given value to the array.

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 Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p update-mask=string
    • Field mask to use for partial in-place updates.

Optional General Properties

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

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -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

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").