Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.

Method Details

close()

Close httplib2 connections.

get(profileId, id, x__xgafv=None)

Gets one remarketing list by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Remarketing list ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to facilitate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
  "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
  "active": True or False, # Whether this targetable remarketing list is active.
  "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
  "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "description": "A String", # Targetable remarketing list description.
  "id": "A String", # Targetable remarketing list ID.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
  "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
  "listSize": "A String", # Number of users currently in the list. This is a read-only field.
  "listSource": "A String", # Product from which this targetable remarketing list was originated.
  "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
  "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
}

list(profileId, advertiserId, active=None, maxResults=None, name=None, pageToken=None, sortField=None, sortOrder=None, x__xgafv=None)

Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.

Args:
profileId: string, User profile ID associated with this request. (required)
advertiserId: string, Required. Select only targetable remarketing lists targetable by these advertisers. (required)
active: boolean, Select only active or only inactive targetable remarketing lists.
maxResults: integer, Maximum number of results to return.
name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
pageToken: string, Value of the nextPageToken from the previous result page.
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Targetable remarketing list response
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse".
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"targetableRemarketingLists": [ # Targetable remarketing list collection.
{ # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to facilitate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
"accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
"active": True or False, # Whether this targetable remarketing list is active.
"advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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": "A String", # The value of the dimension.
},
"description": "A String", # Targetable remarketing list description.
"id": "A String", # Targetable remarketing list ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
"lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
"listSize": "A String", # Number of users currently in the list. This is a read-only field.
"listSource": "A String", # Product from which this targetable remarketing list was originated.
"name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
"subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
},
],
}

Campaign Manager 360 API . targetableRemarketingLists

Instance Methods

Method Details