Home | History | Annotate | Download | only in dyn 
      1 <html><body>
      2 <style>
      3 
      4 body, h1, h2, h3, div, span, p, pre, a {
      5   margin: 0;
      6   padding: 0;
      7   border: 0;
      8   font-weight: inherit;
      9   font-style: inherit;
     10   font-size: 100%;
     11   font-family: inherit;
     12   vertical-align: baseline;
     13 }
     14 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, h2, h3 {
     50   border-bottom: solid #CCC 1px;
     51 }
     52 
     53 .toc_element {
     54   margin-top: 0.5em;
     55 }
     56 
     57 .firstline {
     58   margin-left: 2 em;
     59 }
     60 
     61 .method  {
     62   margin-top: 1em;
     63   border: solid 1px #CCC;
     64   padding: 1em;
     65   background: #EEE;
     66 }
     67 
     68 .details {
     69   font-weight: bold;
     70   font-size: 14px;
     71 }
     72 
     73 </style>
     74 
     75 <h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.remarketingAudience.html">remarketingAudience</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#delete">delete(accountId, webPropertyId, remarketingAudienceId)</a></code></p>
     79 <p class="firstline">Delete a remarketing audience.</p>
     80 <p class="toc_element">
     81   <code><a href="#get">get(accountId, webPropertyId, remarketingAudienceId)</a></code></p>
     82 <p class="firstline">Gets a remarketing audience to which the user has access.</p>
     83 <p class="toc_element">
     84   <code><a href="#insert">insert(accountId, webPropertyId, body)</a></code></p>
     85 <p class="firstline">Creates a new remarketing audience.</p>
     86 <p class="toc_element">
     87   <code><a href="#list">list(accountId, webPropertyId, max_results=None, type=None, start_index=None)</a></code></p>
     88 <p class="firstline">Lists remarketing audiences to which the user has access.</p>
     89 <p class="toc_element">
     90   <code><a href="#patch">patch(accountId, webPropertyId, remarketingAudienceId, body)</a></code></p>
     91 <p class="firstline">Updates an existing remarketing audience. This method supports patch semantics.</p>
     92 <p class="toc_element">
     93   <code><a href="#update">update(accountId, webPropertyId, remarketingAudienceId, body)</a></code></p>
     94 <p class="firstline">Updates an existing remarketing audience.</p>
     95 <h3>Method Details</h3>
     96 <div class="method">
     97     <code class="details" id="delete">delete(accountId, webPropertyId, remarketingAudienceId)</code>
     98   <pre>Delete a remarketing audience.
     99 
    100 Args:
    101   accountId: string, Account ID to which the remarketing audience belongs. (required)
    102   webPropertyId: string, Web property ID to which the remarketing audience belongs. (required)
    103   remarketingAudienceId: string, The ID of the remarketing audience to delete. (required)
    104 </pre>
    105 </div>
    106 
    107 <div class="method">
    108     <code class="details" id="get">get(accountId, webPropertyId, remarketingAudienceId)</code>
    109   <pre>Gets a remarketing audience to which the user has access.
    110 
    111 Args:
    112   accountId: string, The account ID of the remarketing audience to retrieve. (required)
    113   webPropertyId: string, The web property ID of the remarketing audience to retrieve. (required)
    114   remarketingAudienceId: string, The ID of the remarketing audience to retrieve. (required)
    115 
    116 Returns:
    117   An object of the form:
    118 
    119     { # JSON template for an Analytics remarketing audience.
    120       "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
    121         { # JSON template for an Analytics Remarketing Audience Foreign Link.
    122           "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
    123           "status": "A String", # The status of this foreign account link.
    124           "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
    125           "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
    126           "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
    127           "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
    128           "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
    129           "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
    130           "id": "A String", # Entity ad account link ID.
    131           "accountId": "A String", # Account ID to which this linked foreign account belongs.
    132         },
    133       ],
    134       "kind": "analytics#remarketingAudience", # Collection type.
    135       "description": "A String", # The description of this remarketing audience.
    136       "created": "A String", # Time this remarketing audience was created.
    137       "updated": "A String", # Time this remarketing audience was last modified.
    138       "name": "A String", # The name of this remarketing audience.
    139       "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
    140       "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
    141         "A String",
    142       ],
    143       "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
    144         "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    145           "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    146           "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    147           "kind": "analytics#includeConditions", # Resource type for include conditions.
    148           "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    149           "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    150         },
    151         "excludeConditions": { # Defines the conditions to exclude users from the audience.
    152           "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
    153           "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
    154         },
    155       },
    156       "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
    157       "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
    158       "accountId": "A String", # Account ID to which this remarketing audience belongs.
    159       "id": "A String", # Remarketing Audience ID.
    160       "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
    161         "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    162           "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    163           "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    164           "kind": "analytics#includeConditions", # Resource type for include conditions.
    165           "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    166           "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    167         },
    168       },
    169     }</pre>
    170 </div>
    171 
    172 <div class="method">
    173     <code class="details" id="insert">insert(accountId, webPropertyId, body)</code>
    174   <pre>Creates a new remarketing audience.
    175 
    176 Args:
    177   accountId: string, The account ID for which to create the remarketing audience. (required)
    178   webPropertyId: string, Web property ID for which to create the remarketing audience. (required)
    179   body: object, The request body. (required)
    180     The object takes the form of:
    181 
    182 { # JSON template for an Analytics remarketing audience.
    183     "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
    184       { # JSON template for an Analytics Remarketing Audience Foreign Link.
    185         "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
    186         "status": "A String", # The status of this foreign account link.
    187         "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
    188         "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
    189         "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
    190         "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
    191         "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
    192         "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
    193         "id": "A String", # Entity ad account link ID.
    194         "accountId": "A String", # Account ID to which this linked foreign account belongs.
    195       },
    196     ],
    197     "kind": "analytics#remarketingAudience", # Collection type.
    198     "description": "A String", # The description of this remarketing audience.
    199     "created": "A String", # Time this remarketing audience was created.
    200     "updated": "A String", # Time this remarketing audience was last modified.
    201     "name": "A String", # The name of this remarketing audience.
    202     "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
    203     "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
    204       "A String",
    205     ],
    206     "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
    207       "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    208         "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    209         "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    210         "kind": "analytics#includeConditions", # Resource type for include conditions.
    211         "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    212         "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    213       },
    214       "excludeConditions": { # Defines the conditions to exclude users from the audience.
    215         "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
    216         "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
    217       },
    218     },
    219     "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
    220     "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
    221     "accountId": "A String", # Account ID to which this remarketing audience belongs.
    222     "id": "A String", # Remarketing Audience ID.
    223     "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
    224       "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    225         "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    226         "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    227         "kind": "analytics#includeConditions", # Resource type for include conditions.
    228         "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    229         "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    230       },
    231     },
    232   }
    233 
    234 
    235 Returns:
    236   An object of the form:
    237 
    238     { # JSON template for an Analytics remarketing audience.
    239       "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
    240         { # JSON template for an Analytics Remarketing Audience Foreign Link.
    241           "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
    242           "status": "A String", # The status of this foreign account link.
    243           "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
    244           "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
    245           "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
    246           "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
    247           "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
    248           "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
    249           "id": "A String", # Entity ad account link ID.
    250           "accountId": "A String", # Account ID to which this linked foreign account belongs.
    251         },
    252       ],
    253       "kind": "analytics#remarketingAudience", # Collection type.
    254       "description": "A String", # The description of this remarketing audience.
    255       "created": "A String", # Time this remarketing audience was created.
    256       "updated": "A String", # Time this remarketing audience was last modified.
    257       "name": "A String", # The name of this remarketing audience.
    258       "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
    259       "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
    260         "A String",
    261       ],
    262       "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
    263         "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    264           "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    265           "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    266           "kind": "analytics#includeConditions", # Resource type for include conditions.
    267           "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    268           "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    269         },
    270         "excludeConditions": { # Defines the conditions to exclude users from the audience.
    271           "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
    272           "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
    273         },
    274       },
    275       "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
    276       "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
    277       "accountId": "A String", # Account ID to which this remarketing audience belongs.
    278       "id": "A String", # Remarketing Audience ID.
    279       "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
    280         "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    281           "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    282           "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    283           "kind": "analytics#includeConditions", # Resource type for include conditions.
    284           "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    285           "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    286         },
    287       },
    288     }</pre>
    289 </div>
    290 
    291 <div class="method">
    292     <code class="details" id="list">list(accountId, webPropertyId, max_results=None, type=None, start_index=None)</code>
    293   <pre>Lists remarketing audiences to which the user has access.
    294 
    295 Args:
    296   accountId: string, The account ID of the remarketing audiences to retrieve. (required)
    297   webPropertyId: string, The web property ID of the remarketing audiences to retrieve. (required)
    298   max_results: integer, The maximum number of remarketing audiences to include in this response.
    299   type: string, A parameter
    300   start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
    301 
    302 Returns:
    303   An object of the form:
    304 
    305     { # A remarketing audience collection lists Analytics remarketing audiences to which the user has access. Each resource in the collection corresponds to a single Analytics remarketing audience.
    306     "username": "A String", # Email ID of the authenticated user
    307     "kind": "analytics#remarketingAudiences", # Collection type.
    308     "items": [ # A list of remarketing audiences.
    309       { # JSON template for an Analytics remarketing audience.
    310           "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
    311             { # JSON template for an Analytics Remarketing Audience Foreign Link.
    312               "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
    313               "status": "A String", # The status of this foreign account link.
    314               "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
    315               "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
    316               "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
    317               "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
    318               "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
    319               "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
    320               "id": "A String", # Entity ad account link ID.
    321               "accountId": "A String", # Account ID to which this linked foreign account belongs.
    322             },
    323           ],
    324           "kind": "analytics#remarketingAudience", # Collection type.
    325           "description": "A String", # The description of this remarketing audience.
    326           "created": "A String", # Time this remarketing audience was created.
    327           "updated": "A String", # Time this remarketing audience was last modified.
    328           "name": "A String", # The name of this remarketing audience.
    329           "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
    330           "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
    331             "A String",
    332           ],
    333           "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
    334             "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    335               "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    336               "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    337               "kind": "analytics#includeConditions", # Resource type for include conditions.
    338               "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    339               "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    340             },
    341             "excludeConditions": { # Defines the conditions to exclude users from the audience.
    342               "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
    343               "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
    344             },
    345           },
    346           "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
    347           "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
    348           "accountId": "A String", # Account ID to which this remarketing audience belongs.
    349           "id": "A String", # Remarketing Audience ID.
    350           "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
    351             "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    352               "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    353               "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    354               "kind": "analytics#includeConditions", # Resource type for include conditions.
    355               "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    356               "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    357             },
    358           },
    359         },
    360     ],
    361     "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
    362     "previousLink": "A String", # Link to previous page for this view (profile) collection.
    363     "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
    364     "nextLink": "A String", # Link to next page for this remarketing audience collection.
    365     "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
    366   }</pre>
    367 </div>
    368 
    369 <div class="method">
    370     <code class="details" id="patch">patch(accountId, webPropertyId, remarketingAudienceId, body)</code>
    371   <pre>Updates an existing remarketing audience. This method supports patch semantics.
    372 
    373 Args:
    374   accountId: string, The account ID of the remarketing audience to update. (required)
    375   webPropertyId: string, The web property ID of the remarketing audience to update. (required)
    376   remarketingAudienceId: string, The ID of the remarketing audience to update. (required)
    377   body: object, The request body. (required)
    378     The object takes the form of:
    379 
    380 { # JSON template for an Analytics remarketing audience.
    381     "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
    382       { # JSON template for an Analytics Remarketing Audience Foreign Link.
    383         "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
    384         "status": "A String", # The status of this foreign account link.
    385         "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
    386         "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
    387         "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
    388         "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
    389         "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
    390         "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
    391         "id": "A String", # Entity ad account link ID.
    392         "accountId": "A String", # Account ID to which this linked foreign account belongs.
    393       },
    394     ],
    395     "kind": "analytics#remarketingAudience", # Collection type.
    396     "description": "A String", # The description of this remarketing audience.
    397     "created": "A String", # Time this remarketing audience was created.
    398     "updated": "A String", # Time this remarketing audience was last modified.
    399     "name": "A String", # The name of this remarketing audience.
    400     "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
    401     "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
    402       "A String",
    403     ],
    404     "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
    405       "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    406         "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    407         "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    408         "kind": "analytics#includeConditions", # Resource type for include conditions.
    409         "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    410         "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    411       },
    412       "excludeConditions": { # Defines the conditions to exclude users from the audience.
    413         "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
    414         "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
    415       },
    416     },
    417     "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
    418     "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
    419     "accountId": "A String", # Account ID to which this remarketing audience belongs.
    420     "id": "A String", # Remarketing Audience ID.
    421     "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
    422       "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    423         "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    424         "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    425         "kind": "analytics#includeConditions", # Resource type for include conditions.
    426         "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    427         "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    428       },
    429     },
    430   }
    431 
    432 
    433 Returns:
    434   An object of the form:
    435 
    436     { # JSON template for an Analytics remarketing audience.
    437       "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
    438         { # JSON template for an Analytics Remarketing Audience Foreign Link.
    439           "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
    440           "status": "A String", # The status of this foreign account link.
    441           "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
    442           "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
    443           "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
    444           "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
    445           "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
    446           "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
    447           "id": "A String", # Entity ad account link ID.
    448           "accountId": "A String", # Account ID to which this linked foreign account belongs.
    449         },
    450       ],
    451       "kind": "analytics#remarketingAudience", # Collection type.
    452       "description": "A String", # The description of this remarketing audience.
    453       "created": "A String", # Time this remarketing audience was created.
    454       "updated": "A String", # Time this remarketing audience was last modified.
    455       "name": "A String", # The name of this remarketing audience.
    456       "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
    457       "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
    458         "A String",
    459       ],
    460       "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
    461         "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    462           "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    463           "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    464           "kind": "analytics#includeConditions", # Resource type for include conditions.
    465           "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    466           "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    467         },
    468         "excludeConditions": { # Defines the conditions to exclude users from the audience.
    469           "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
    470           "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
    471         },
    472       },
    473       "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
    474       "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
    475       "accountId": "A String", # Account ID to which this remarketing audience belongs.
    476       "id": "A String", # Remarketing Audience ID.
    477       "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
    478         "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    479           "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    480           "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    481           "kind": "analytics#includeConditions", # Resource type for include conditions.
    482           "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    483           "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    484         },
    485       },
    486     }</pre>
    487 </div>
    488 
    489 <div class="method">
    490     <code class="details" id="update">update(accountId, webPropertyId, remarketingAudienceId, body)</code>
    491   <pre>Updates an existing remarketing audience.
    492 
    493 Args:
    494   accountId: string, The account ID of the remarketing audience to update. (required)
    495   webPropertyId: string, The web property ID of the remarketing audience to update. (required)
    496   remarketingAudienceId: string, The ID of the remarketing audience to update. (required)
    497   body: object, The request body. (required)
    498     The object takes the form of:
    499 
    500 { # JSON template for an Analytics remarketing audience.
    501     "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
    502       { # JSON template for an Analytics Remarketing Audience Foreign Link.
    503         "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
    504         "status": "A String", # The status of this foreign account link.
    505         "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
    506         "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
    507         "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
    508         "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
    509         "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
    510         "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
    511         "id": "A String", # Entity ad account link ID.
    512         "accountId": "A String", # Account ID to which this linked foreign account belongs.
    513       },
    514     ],
    515     "kind": "analytics#remarketingAudience", # Collection type.
    516     "description": "A String", # The description of this remarketing audience.
    517     "created": "A String", # Time this remarketing audience was created.
    518     "updated": "A String", # Time this remarketing audience was last modified.
    519     "name": "A String", # The name of this remarketing audience.
    520     "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
    521     "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
    522       "A String",
    523     ],
    524     "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
    525       "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    526         "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    527         "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    528         "kind": "analytics#includeConditions", # Resource type for include conditions.
    529         "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    530         "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    531       },
    532       "excludeConditions": { # Defines the conditions to exclude users from the audience.
    533         "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
    534         "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
    535       },
    536     },
    537     "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
    538     "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
    539     "accountId": "A String", # Account ID to which this remarketing audience belongs.
    540     "id": "A String", # Remarketing Audience ID.
    541     "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
    542       "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    543         "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    544         "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    545         "kind": "analytics#includeConditions", # Resource type for include conditions.
    546         "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    547         "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    548       },
    549     },
    550   }
    551 
    552 
    553 Returns:
    554   An object of the form:
    555 
    556     { # JSON template for an Analytics remarketing audience.
    557       "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
    558         { # JSON template for an Analytics Remarketing Audience Foreign Link.
    559           "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX.
    560           "status": "A String", # The status of this foreign account link.
    561           "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
    562           "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
    563           "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
    564           "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
    565           "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
    566           "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`.
    567           "id": "A String", # Entity ad account link ID.
    568           "accountId": "A String", # Account ID to which this linked foreign account belongs.
    569         },
    570       ],
    571       "kind": "analytics#remarketingAudience", # Collection type.
    572       "description": "A String", # The description of this remarketing audience.
    573       "created": "A String", # Time this remarketing audience was created.
    574       "updated": "A String", # Time this remarketing audience was last modified.
    575       "name": "A String", # The name of this remarketing audience.
    576       "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
    577       "linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
    578         "A String",
    579       ],
    580       "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
    581         "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    582           "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    583           "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    584           "kind": "analytics#includeConditions", # Resource type for include conditions.
    585           "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    586           "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    587         },
    588         "excludeConditions": { # Defines the conditions to exclude users from the audience.
    589           "segment": "A String", # The segment condition that will cause a user to be removed from an audience.
    590           "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
    591         },
    592       },
    593       "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
    594       "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
    595       "accountId": "A String", # Account ID to which this remarketing audience belongs.
    596       "id": "A String", # Remarketing Audience ID.
    597       "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
    598         "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
    599           "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    600           "segment": "A String", # The segment condition that will cause a user to be added to an audience.
    601           "kind": "analytics#includeConditions", # Resource type for include conditions.
    602           "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
    603           "membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
    604         },
    605       },
    606     }</pre>
    607 </div>
    608 
    609 </body></html>