GOgoogle
buyers

PATCH /v1/buyers/{buyersId}/creatives/{creativesId}

Updates a creative.

Request

  • Base URL
    https://realtimebidding.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/realtime-bidding
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/realtime-bidding
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

buyersIdstring required
creativesIdstring required

Query parameters

updateMaskstring google-fieldmask

Field mask to use for partial in-place updates.

Request body

accountIdstring int64

Output only. ID of the buyer account that this creative is owned by. Can be used to filter the response of the creatives.list method with equality and inequality check.

adChoicesDestinationUrlstring

The link to AdChoices destination page. This is only supported for native ads.

advertiserNamestring

The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method.

agencyIdstring int64

The agency ID for this creative.

apiUpdateTimestring google-datetime

Output only. The last update timestamp of the creative through the API.

creativeFormat'CREATIVE_FORMAT_UNSPECIFIED' | 'HTML' | 'VIDEO' | 'NATIVE'

Output only. The format of this creative. Can be used to filter the response of the creatives.list method.

creativeIdstring

Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes.

dealIdsstring[]

Output only. IDs of all of the deals with which this creative has been used in bidding. Can be used to filter the response of the creatives.list method.

declaredAttributesstring[]

All declared attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. If the excluded_attribute field of a bid request contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.

declaredClickThroughUrlsstring[]

The set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method.

declaredRestrictedCategoriesstring[]

All declared restricted categories for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.

declaredVendorIdsinteger[]

IDs for the declared ad technology vendors that may be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method.

impressionTrackingUrlsstring[]

The set of URLs to be called to record an impression.

namestring

Output only. Name of the creative. Follows the pattern buyers/{buyer}/creatives/{creative}, where {buyer} represents the account ID of the buyer who owns the creative, and {creative} is the buyer-specific creative ID that references this creative in the bid response.

renderUrlstring

Deprecated: FLEDGE is no longer supported. See: https://privacysandbox.google.com/blog/update-on-plans-for-privacy-sandbox-technologies Experimental field that can be used during the FLEDGE Origin Trial. The URL to fetch an interest group ad used in TURTLEDOVE on-device auction. This should be unique among all creatives for a given accountId. This URL should be the same as the URL returned by generateBid().

restrictedCategoriesstring[]

All restricted categories for the ads that may be shown from this creative.

versioninteger

Output only. The version of the creative. Version for a new creative is 1 and it increments during subsequent creative updates.

Response

Successful response

accountIdstring int64

Output only. ID of the buyer account that this creative is owned by. Can be used to filter the response of the creatives.list method with equality and inequality check.

adChoicesDestinationUrlstring

The link to AdChoices destination page. This is only supported for native ads.

advertiserNamestring

The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method.

agencyIdstring int64

The agency ID for this creative.

apiUpdateTimestring google-datetime

Output only. The last update timestamp of the creative through the API.

creativeFormat'CREATIVE_FORMAT_UNSPECIFIED' | 'HTML' | 'VIDEO' | 'NATIVE'

Output only. The format of this creative. Can be used to filter the response of the creatives.list method.

creativeIdstring

Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes.

dealIdsstring[]

Output only. IDs of all of the deals with which this creative has been used in bidding. Can be used to filter the response of the creatives.list method.

declaredAttributesstring[]

All declared attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. If the excluded_attribute field of a bid request contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.

declaredClickThroughUrlsstring[]

The set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method.

declaredRestrictedCategoriesstring[]

All declared restricted categories for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.

declaredVendorIdsinteger[]

IDs for the declared ad technology vendors that may be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method.

impressionTrackingUrlsstring[]

The set of URLs to be called to record an impression.

namestring

Output only. Name of the creative. Follows the pattern buyers/{buyer}/creatives/{creative}, where {buyer} represents the account ID of the buyer who owns the creative, and {creative} is the buyer-specific creative ID that references this creative in the bid response.

renderUrlstring

Deprecated: FLEDGE is no longer supported. See: https://privacysandbox.google.com/blog/update-on-plans-for-privacy-sandbox-technologies Experimental field that can be used during the FLEDGE Origin Trial. The URL to fetch an interest group ad used in TURTLEDOVE on-device auction. This should be unique among all creatives for a given accountId. This URL should be the same as the URL returned by generateBid().

restrictedCategoriesstring[]

All restricted categories for the ads that may be shown from this creative.

versioninteger

Output only. The version of the creative. Version for a new creative is 1 and it increments during subsequent creative updates.

Changes

No recorded changes to this operation across all 5 revisions of this API.