| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="dfareporting_v2_6.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_6.remarketingLists.html">remarketingLists</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#get">get(profileId, id)</a></code></p> |
| <p class="firstline">Gets one remarketing list by ID.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(profileId, body)</a></code></p> |
| <p class="firstline">Inserts a new remarketing list.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None)</a></code></p> |
| <p class="firstline">Retrieves a list of remarketing lists, possibly filtered. This method supports paging.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(profileId, id, body)</a></code></p> |
| <p class="firstline">Updates an existing remarketing list. This method supports patch semantics.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(profileId, body)</a></code></p> |
| <p class="firstline">Updates an existing remarketing list.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="get">get(profileId, id)</code> |
| <pre>Gets one remarketing list by ID. |
| |
| Args: |
| profileId: string, User profile ID associated with this request. (required) |
| id: string, Remarketing list ID. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains properties of a 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 can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. |
| "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. |
| "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. |
| "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. |
| "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. |
| { # A group clause made up of list population terms representing constraints joined by ORs. |
| "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. |
| { # Remarketing List Population Rule Term. |
| "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. |
| "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. |
| "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. |
| "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. |
| "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| }, |
| ], |
| }, |
| ], |
| }, |
| "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". |
| "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| "description": "A String", # Remarketing list description. |
| "listSize": "A String", # Number of users currently in the list. This is a read-only field. |
| "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. |
| "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. |
| "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. |
| "listSource": "A String", # Product from which this remarketing list was originated. |
| "active": True or False, # Whether this remarketing list is active. |
| "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
| "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. |
| "value": "A String", # The value of the dimension. |
| "dimensionName": "A String", # The name of the dimension. |
| "etag": "A String", # The eTag of this response for caching purposes. |
| "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. |
| "id": "A String", # The ID associated with the value if available. |
| }, |
| "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. |
| "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(profileId, body)</code> |
| <pre>Inserts a new remarketing list. |
| |
| Args: |
| profileId: string, User profile ID associated with this request. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # Contains properties of a 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 can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. |
| "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. |
| "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. |
| "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. |
| "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. |
| { # A group clause made up of list population terms representing constraints joined by ORs. |
| "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. |
| { # Remarketing List Population Rule Term. |
| "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. |
| "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. |
| "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. |
| "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. |
| "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| }, |
| ], |
| }, |
| ], |
| }, |
| "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". |
| "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| "description": "A String", # Remarketing list description. |
| "listSize": "A String", # Number of users currently in the list. This is a read-only field. |
| "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. |
| "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. |
| "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. |
| "listSource": "A String", # Product from which this remarketing list was originated. |
| "active": True or False, # Whether this remarketing list is active. |
| "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
| "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. |
| "value": "A String", # The value of the dimension. |
| "dimensionName": "A String", # The name of the dimension. |
| "etag": "A String", # The eTag of this response for caching purposes. |
| "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. |
| "id": "A String", # The ID associated with the value if available. |
| }, |
| "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. |
| "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains properties of a 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 can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. |
| "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. |
| "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. |
| "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. |
| "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. |
| { # A group clause made up of list population terms representing constraints joined by ORs. |
| "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. |
| { # Remarketing List Population Rule Term. |
| "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. |
| "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. |
| "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. |
| "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. |
| "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| }, |
| ], |
| }, |
| ], |
| }, |
| "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". |
| "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| "description": "A String", # Remarketing list description. |
| "listSize": "A String", # Number of users currently in the list. This is a read-only field. |
| "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. |
| "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. |
| "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. |
| "listSource": "A String", # Product from which this remarketing list was originated. |
| "active": True or False, # Whether this remarketing list is active. |
| "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
| "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. |
| "value": "A String", # The value of the dimension. |
| "dimensionName": "A String", # The name of the dimension. |
| "etag": "A String", # The eTag of this response for caching purposes. |
| "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. |
| "id": "A String", # The ID associated with the value if available. |
| }, |
| "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. |
| "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None)</code> |
| <pre>Retrieves a list of remarketing lists, possibly filtered. This method supports paging. |
| |
| Args: |
| profileId: string, User profile ID associated with this request. (required) |
| advertiserId: string, Select only remarketing lists owned by this advertiser. (required) |
| 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 - |
| floodlightActivityId: string, Select only remarketing lists that have this floodlight activity ID. |
| maxResults: integer, Maximum number of results to return. |
| active: boolean, Select only active or only inactive remarketing lists. |
| sortOrder: string, Order of sorted results, default is ASCENDING. |
| Allowed values |
| ASCENDING - |
| DESCENDING - |
| |
| Returns: |
| An object of the form: |
| |
| { # Remarketing list response |
| "nextPageToken": "A String", # Pagination token to be used for the next list operation. |
| "remarketingLists": [ # Remarketing list collection. |
| { # Contains properties of a 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 can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. |
| "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. |
| "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. |
| "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. |
| "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. |
| { # A group clause made up of list population terms representing constraints joined by ORs. |
| "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. |
| { # Remarketing List Population Rule Term. |
| "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. |
| "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. |
| "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. |
| "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. |
| "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| }, |
| ], |
| }, |
| ], |
| }, |
| "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". |
| "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| "description": "A String", # Remarketing list description. |
| "listSize": "A String", # Number of users currently in the list. This is a read-only field. |
| "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. |
| "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. |
| "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. |
| "listSource": "A String", # Product from which this remarketing list was originated. |
| "active": True or False, # Whether this remarketing list is active. |
| "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
| "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. |
| "value": "A String", # The value of the dimension. |
| "dimensionName": "A String", # The name of the dimension. |
| "etag": "A String", # The eTag of this response for caching purposes. |
| "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. |
| "id": "A String", # The ID associated with the value if available. |
| }, |
| "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. |
| "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| }, |
| ], |
| "kind": "dfareporting#remarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(profileId, id, body)</code> |
| <pre>Updates an existing remarketing list. This method supports patch semantics. |
| |
| Args: |
| profileId: string, User profile ID associated with this request. (required) |
| id: string, Remarketing list ID. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # Contains properties of a 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 can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. |
| "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. |
| "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. |
| "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. |
| "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. |
| { # A group clause made up of list population terms representing constraints joined by ORs. |
| "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. |
| { # Remarketing List Population Rule Term. |
| "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. |
| "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. |
| "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. |
| "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. |
| "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| }, |
| ], |
| }, |
| ], |
| }, |
| "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". |
| "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| "description": "A String", # Remarketing list description. |
| "listSize": "A String", # Number of users currently in the list. This is a read-only field. |
| "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. |
| "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. |
| "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. |
| "listSource": "A String", # Product from which this remarketing list was originated. |
| "active": True or False, # Whether this remarketing list is active. |
| "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
| "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. |
| "value": "A String", # The value of the dimension. |
| "dimensionName": "A String", # The name of the dimension. |
| "etag": "A String", # The eTag of this response for caching purposes. |
| "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. |
| "id": "A String", # The ID associated with the value if available. |
| }, |
| "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. |
| "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains properties of a 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 can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. |
| "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. |
| "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. |
| "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. |
| "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. |
| { # A group clause made up of list population terms representing constraints joined by ORs. |
| "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. |
| { # Remarketing List Population Rule Term. |
| "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. |
| "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. |
| "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. |
| "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. |
| "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| }, |
| ], |
| }, |
| ], |
| }, |
| "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". |
| "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| "description": "A String", # Remarketing list description. |
| "listSize": "A String", # Number of users currently in the list. This is a read-only field. |
| "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. |
| "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. |
| "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. |
| "listSource": "A String", # Product from which this remarketing list was originated. |
| "active": True or False, # Whether this remarketing list is active. |
| "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
| "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. |
| "value": "A String", # The value of the dimension. |
| "dimensionName": "A String", # The name of the dimension. |
| "etag": "A String", # The eTag of this response for caching purposes. |
| "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. |
| "id": "A String", # The ID associated with the value if available. |
| }, |
| "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. |
| "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(profileId, body)</code> |
| <pre>Updates an existing remarketing list. |
| |
| Args: |
| profileId: string, User profile ID associated with this request. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # Contains properties of a 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 can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. |
| "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. |
| "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. |
| "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. |
| "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. |
| { # A group clause made up of list population terms representing constraints joined by ORs. |
| "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. |
| { # Remarketing List Population Rule Term. |
| "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. |
| "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. |
| "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. |
| "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. |
| "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| }, |
| ], |
| }, |
| ], |
| }, |
| "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". |
| "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| "description": "A String", # Remarketing list description. |
| "listSize": "A String", # Number of users currently in the list. This is a read-only field. |
| "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. |
| "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. |
| "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. |
| "listSource": "A String", # Product from which this remarketing list was originated. |
| "active": True or False, # Whether this remarketing list is active. |
| "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
| "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. |
| "value": "A String", # The value of the dimension. |
| "dimensionName": "A String", # The name of the dimension. |
| "etag": "A String", # The eTag of this response for caching purposes. |
| "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. |
| "id": "A String", # The ID associated with the value if available. |
| }, |
| "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. |
| "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains properties of a 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 can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. |
| "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users. |
| "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. |
| "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank. |
| "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. |
| { # A group clause made up of list population terms representing constraints joined by ORs. |
| "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. |
| { # Remarketing List Population Rule Term. |
| "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. |
| "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. |
| "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. |
| "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. |
| "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. |
| }, |
| ], |
| }, |
| ], |
| }, |
| "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". |
| "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| "description": "A String", # Remarketing list description. |
| "listSize": "A String", # Number of users currently in the list. This is a read-only field. |
| "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. |
| "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. |
| "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field. |
| "listSource": "A String", # Product from which this remarketing list was originated. |
| "active": True or False, # Whether this remarketing list is active. |
| "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
| "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. |
| "value": "A String", # The value of the dimension. |
| "dimensionName": "A String", # The name of the dimension. |
| "etag": "A String", # The eTag of this response for caching purposes. |
| "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. |
| "id": "A String", # The ID associated with the value if available. |
| }, |
| "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field. |
| "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| }</pre> |
| </div> |
| |
| </body></html> |
