Updates an existing placement group. This method supports patch semantics.

Scopes

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

If unset, the scope for this method defaults to https://www.googleapis.com/auth/dfatrafficking. You can set the scope for this method like this: dfareporting3d2 --scope <scope> placement-groups patch ...

Required Scalar Arguments

• <profile-id> (string)
  • User profile ID associated with this request.
• <id> (string)
  • Placement group 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:

PlacementGroup:
  account-id: string
  advertiser-id: string
  advertiser-id-dimension-value:
    dimension-name: string
    etag: string
    id: string
    kind: string
    match-type: string
    value: string
  archived: boolean
  campaign-id: string
  campaign-id-dimension-value:
    dimension-name: string
    etag: string
    id: string
    kind: string
    match-type: string
    value: string
  child-placement-ids: [string]
  comment: string
  content-category-id: string
  create-info:
    time: string
  directory-site-id: string
  directory-site-id-dimension-value:
    dimension-name: string
    etag: string
    id: string
    kind: string
    match-type: string
    value: string
  external-id: string
  id: string
  id-dimension-value:
    dimension-name: string
    etag: string
    id: string
    kind: string
    match-type: string
    value: string
  kind: string
  last-modified-info:
    time: string
  name: string
  placement-group-type: string
  placement-strategy-id: string
  pricing-schedule:
    cap-cost-option: string
    disregard-overdelivery: boolean
    end-date: string
    flighted: boolean
    floodlight-activity-id: string
    pricing-type: string
    start-date: string
    testing-start-date: string
  primary-placement-id: string
  primary-placement-id-dimension-value:
    dimension-name: string
    etag: string
    id: string
    kind: string
    match-type: string
    value: string
  site-id: string
  site-id-dimension-value:
    dimension-name: string
    etag: string
    id: string
    kind: string
    match-type: string
    value: string
  subaccount-id: 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=magna
  • Account ID of this placement group. This is a read-only field that can be left blank.
• advertiser-id=dolore
  • Advertiser ID of this placement group. This is a required field on insertion.
• advertiser-id-dimension-value dimension-name=erat
  • The name of the dimension.
• etag=sed
  • The eTag of this response for caching purposes.
• id=et
  • The ID associated with the value if available.
• kind=justo
  • The kind of resource this is, in this case dfareporting#dimensionValue.
• match-type=invidunt
  • 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=justo

  • The value of the dimension.

• .. archived=true

  • Whether this placement group is archived.
• campaign-id=voluptua.
  • Campaign ID of this placement group. This field is required on insertion.
• campaign-id-dimension-value dimension-name=takimata
  • The name of the dimension.
• etag=amet
  • The eTag of this response for caching purposes.
• id=voluptua.
  • The ID associated with the value if available.
• kind=lorem
  • 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=eos

  • The value of the dimension.

• .. child-placement-ids=sanctus

  • IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
  • Each invocation of this argument appends the given value to the array.
• comment=eos
  • Comments for this placement group.
• content-category-id=dolor
  • ID of the content category assigned to this placement group.

• create-info time=amet.

  • Timestamp of the last change in milliseconds since epoch.

• .. directory-site-id=gubergren

  • Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
• directory-site-id-dimension-value dimension-name=ipsum
  • The name of the dimension.
• etag=kasd
  • The eTag of this response for caching purposes.
• id=no
  • The ID associated with the value if available.
• kind=lorem
  • The kind of resource this is, in this case dfareporting#dimensionValue.
• match-type=et
  • 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=nonumy

  • The value of the dimension.

• .. external-id=amet

  • External ID for this placement.
• id=lorem
  • ID of this placement group. This is a read-only, auto-generated field.
• id-dimension-value dimension-name=accusam
  • The name of the dimension.
• etag=sed
  • The eTag of this response for caching purposes.
• id=vero
  • The ID associated with the value if available.
• kind=est
  • The kind of resource this is, in this case dfareporting#dimensionValue.
• match-type=voluptua.
  • 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=dolores

  • The value of the dimension.

• .. kind=stet

  • Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".

• last-modified-info time=aliquyam

  • Timestamp of the last change in milliseconds since epoch.

• .. name=justo

  • Name of this placement group. This is a required field and must be less than 256 characters long.
• placement-group-type=clita
  • Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
• placement-strategy-id=dolores
  • ID of the placement strategy assigned to this placement group.
• pricing-schedule cap-cost-option=clita
  • Placement cap cost option.
• disregard-overdelivery=false
  • Whether cap costs are ignored by ad serving.
• end-date=duo
  • Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
• flighted=false
  • Whether this placement is flighted. If true, pricing periods will be computed automatically.
• floodlight-activity-id=vero
  • Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
• pricing-type=magna
  • Placement pricing type. This field is required on insertion.
• start-date=nonumy
  • Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.

• testing-start-date=gubergren

  • Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.

• .. primary-placement-id=sadipscing

  • ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
• primary-placement-id-dimension-value dimension-name=at
  • The name of the dimension.
• etag=kasd
  • The eTag of this response for caching purposes.
• id=consetetur
  • The ID associated with the value if available.
• kind=invidunt
  • The kind of resource this is, in this case dfareporting#dimensionValue.
• match-type=lorem
  • 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=et

  • The value of the dimension.

• .. site-id=lorem

  • Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
• site-id-dimension-value dimension-name=consetetur
  • The name of the dimension.
• etag=labore
  • The eTag of this response for caching purposes.
• id=stet
  • The ID associated with the value if available.
• kind=amet.
  • The kind of resource this is, in this case dfareporting#dimensionValue.
• match-type=dolor
  • 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=et

  • The value of the dimension.

• .. subaccount-id=sed

  • Subaccount ID of this placement group. This is a read-only field that can be left blank.

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.