<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="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.accounts.creatives.html">creatives</a> . <a href="adexchangebuyer2_v2beta1.accounts.creatives.dealAssociations.html">dealAssociations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#add">add(accountId, creativeId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Associate an existing deal with a creative.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, creativeId, pageSize=None, pageToken=None, x__xgafv=None, query=None)</a></code></p>
<p class="firstline">List all creative-deal associations.</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="#remove">remove(accountId, creativeId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Remove the association between a deal and a creative.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="add">add(accountId, creativeId, body, x__xgafv=None)</code>
<pre>Associate an existing deal with a creative.
Args:
accountId: string, The account the creative belongs to. (required)
creativeId: string, The ID of the creative associated with the deal. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A request for associating a deal and a creative.
"association": { # The association between a creative and a deal. # The association between a creative and a deal that should be added.
"dealsId": "A String", # The externalDealId for the deal associated with the creative.
"creativeId": "A String", # The ID of the creative associated with the deal.
"accountId": "A String", # The account the creative belongs to.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, creativeId, pageSize=None, pageToken=None, x__xgafv=None, query=None)</code>
<pre>List all creative-deal associations.
Args:
accountId: string, The account to list the associations from.
Specify "-" to list all creatives the current user has access to. (required)
creativeId: string, The creative ID to list the associations from.
Specify "-" to list all creatives under the above account. (required)
pageSize: integer, Requested page size. Server may return fewer associations than requested.
If unspecified, server will pick an appropriate default.
pageToken: string, A token identifying a page of results the server should return.
Typically, this is the value of
ListDealAssociationsResponse.next_page_token
returned from the previous call to 'ListDealAssociations' method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
query: string, An optional query string to filter deal associations. If no filter is
specified, all associations will be returned.
Supported queries are:
<ul>
<li>accountId=<i>account_id_string</i>
<li>creativeId=<i>creative_id_string</i>
<li>dealsId=<i>deals_id_string</i>
<li>dealsStatus:{approved, conditionally_approved, disapproved,
not_checked}
<li>openAuctionStatus:{approved, conditionally_approved, disapproved,
not_checked}
</ul>
Example: 'dealsId=12345 AND dealsStatus:disapproved'
Returns:
An object of the form:
{ # A response for listing creative and deal associations
"associations": [ # The list of associations.
{ # The association between a creative and a deal.
"dealsId": "A String", # The externalDealId for the deal associated with the creative.
"creativeId": "A String", # The ID of the creative associated with the deal.
"accountId": "A String", # The account the creative belongs to.
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results.
# Pass this value in the
# ListDealAssociationsRequest.page_token
# field in the subsequent call to 'ListDealAssociation' method to retrieve
# the next page of results.
}</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="remove">remove(accountId, creativeId, body, x__xgafv=None)</code>
<pre>Remove the association between a deal and a creative.
Args:
accountId: string, The account the creative belongs to. (required)
creativeId: string, The ID of the creative associated with the deal. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A request for removing the association between a deal and a creative.
"association": { # The association between a creative and a deal. # The association between a creative and a deal that should be removed.
"dealsId": "A String", # The externalDealId for the deal associated with the creative.
"creativeId": "A String", # The ID of the creative associated with the deal.
"accountId": "A String", # The account the creative belongs to.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
</body></html>