GOgoogle
remarketingLists

PATCH /userprofiles/{userprofilesId}/remarketingLists

Updates an existing remarketing list. This method supports patch semantics.

Request

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

Path parameters

userprofilesIdstring required

Query parameters

idstring int64 required

Required. RemarketingList ID.

Request body

accountIdstring int64

Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.

activeboolean

Whether this remarketing list is active.

advertiserIdstring int64

Dimension value for the advertiser ID that owns this remarketing list. This is a required field.

descriptionstring

Remarketing list description.

idstring int64

Remarketing list ID. This is a read-only, auto-generated field.

kindstring

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

lifeSpanstring int64

Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.

listSizestring int64

Number of users currently in the list. This is a read-only field.

listSource'REMARKETING_LIST_SOURCE_OTHER' | 'REMARKETING_LIST_SOURCE_ADX' | 'REMARKETING_LIST_SOURCE_DFP' | 'REMARKETING_LIST_SOURCE_XFP' | 'REMARKETING_LIST_SOURCE_DFA' | 'REMARKETING_LIST_SOURCE_GA' | 'REMARKETING_LIST_SOURCE_YOUTUBE' | 'REMARKETING_LIST_SOURCE_DBM' | 'REMARKETING_LIST_SOURCE_GPLUS' | 'REMARKETING_LIST_SOURCE_DMP' | 'REMARKETING_LIST_SOURCE_PLAY_STORE'

Product from which this remarketing list was originated.

namestring

Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.

subaccountIdstring int64

Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.

Response

Successful response

accountIdstring int64

Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.

activeboolean

Whether this remarketing list is active.

advertiserIdstring int64

Dimension value for the advertiser ID that owns this remarketing list. This is a required field.

descriptionstring

Remarketing list description.

idstring int64

Remarketing list ID. This is a read-only, auto-generated field.

kindstring

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

lifeSpanstring int64

Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.

listSizestring int64

Number of users currently in the list. This is a read-only field.

listSource'REMARKETING_LIST_SOURCE_OTHER' | 'REMARKETING_LIST_SOURCE_ADX' | 'REMARKETING_LIST_SOURCE_DFP' | 'REMARKETING_LIST_SOURCE_XFP' | 'REMARKETING_LIST_SOURCE_DFA' | 'REMARKETING_LIST_SOURCE_GA' | 'REMARKETING_LIST_SOURCE_YOUTUBE' | 'REMARKETING_LIST_SOURCE_DBM' | 'REMARKETING_LIST_SOURCE_GPLUS' | 'REMARKETING_LIST_SOURCE_DMP' | 'REMARKETING_LIST_SOURCE_PLAY_STORE'

Product from which this remarketing list was originated.

namestring

Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.

subaccountIdstring int64

Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.

Changes

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