Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID

Scopes

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

If unset, the scope for this method defaults to https://www.googleapis.com/auth/display-video. You can set the scope for this method like this: displayvideo1 --scope <scope> first-and-third-party-audiences patch ...

Required Scalar Argument

  • <first-and-third-party-audience-id> (string)
    • Output only. The unique ID of the first and third party audience. Assigned by the system.

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:

FirstAndThirdPartyAudience:
  active-display-audience-size: string
  app-id: string
  audience-source: string
  audience-type: string
  contact-info-list:
    consent:
      ad-personalization: string
      ad-user-data: string
  description: string
  display-audience-size: string
  display-desktop-audience-size: string
  display-mobile-app-audience-size: string
  display-mobile-web-audience-size: string
  display-name: string
  first-and-third-party-audience-id: string
  first-and-third-party-audience-type: string
  gmail-audience-size: string
  membership-duration-days: string
  mobile-device-id-list:
    consent:
      ad-personalization: string
      ad-user-data: string
    mobile-device-ids: [string]
  name: string
  youtube-audience-size: 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 . active-display-audience-size=et
    • Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
  • app-id=aliquyam
    • The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type CUSTOMER_MATCH_DEVICE_ID
  • audience-source=sanctus
    • Output only. The source of the audience.
  • audience-type=sed
    • The type of the audience.
  • contact-info-list.consent ad-personalization=tempor
    • Represents consent for ad personalization.

  • ad-user-data=dolore

    • Represents consent for ad user data.

  • ... description=dolore

    • The user-provided description of the audience. Only applicable to first party audiences.
  • display-audience-size=ipsum
    • Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
  • display-desktop-audience-size=takimata
    • Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
  • display-mobile-app-audience-size=justo
    • Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
  • display-mobile-web-audience-size=ea
    • Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
  • display-name=ipsum
    • The display name of the first and third party audience.
  • first-and-third-party-audience-id=diam
    • Output only. The unique ID of the first and third party audience. Assigned by the system.
  • first-and-third-party-audience-type=sed
    • Whether the audience is a first or third party audience.
  • gmail-audience-size=justo
    • Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
  • membership-duration-days=ea
    • The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID
  • mobile-device-id-list.consent ad-personalization=et
    • Represents consent for ad personalization.

  • ad-user-data=dolor

    • Represents consent for ad user data.

  • .. mobile-device-ids=dolores

    • A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
    • Each invocation of this argument appends the given value to the array.

  • .. name=amet

    • Output only. The resource name of the first and third party audience.
  • youtube-audience-size=sit
    • Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.

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 advertiser-id=string

    • Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.

  • -p update-mask=string

    • Required. The mask to control which fields to update. Updates are only supported for the following fields: * displayName * description * membershipDurationDays

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").