Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4d1153db18a3edf86c5bb83149b4f1c0ba95f810 / . / docs / dyn / dfareporting_v3_4.campaignCreativeAssociations.html
blob: 80d62a7a76b34c5d70acbf097d515b2123ca0581 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]75<h1><a href="dfareporting_v3_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.campaignCreativeAssociations.html">campaignCreativeAssociations</a></h1>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#insert">insert(profileId, campaignId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]82<p class="firstline">Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.</p>
83<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]84 <code><a href="#list">list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]85<p class="firstline">Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
96 <code class="details" id="insert">insert(profileId, campaignId, body=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]97 <pre>Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.
98
99Args:
100 profileId: string, User profile ID associated with this request. (required)
101 campaignId: string, Campaign ID in this association. (required)
102 body: object, The request body.
103 The object takes the form of:
104
105{ # Identifies a creative which has been associated with a given campaign.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]106 &quot;creativeId&quot;: &quot;A String&quot;, # ID of the creative associated with the campaign. This is a required field.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]107 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#campaignCreativeAssociation&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]108}
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]114
115Returns:
116 An object of the form:
117
118 { # Identifies a creative which has been associated with a given campaign.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]119 &quot;creativeId&quot;: &quot;A String&quot;, # ID of the creative associated with the campaign. This is a required field.
120 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#campaignCreativeAssociation&quot;.
121}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122</div>
123
124<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]125 <code class="details" id="list">list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]126 <pre>Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.
127
128Args:
129 profileId: string, User profile ID associated with this request. (required)
130 campaignId: string, Campaign ID in this association. (required)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]131 maxResults: integer, Maximum number of results to return.
132 pageToken: string, Value of the nextPageToken from the previous result page.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 sortOrder: string, Order of sorted results.
134 Allowed values
135 ASCENDING -
136 DESCENDING -
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141
142Returns:
143 An object of the form:
144
145 { # Campaign Creative Association List Response
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]146 &quot;campaignCreativeAssociations&quot;: [ # Campaign creative association collection
147 { # Identifies a creative which has been associated with a given campaign.
148 &quot;creativeId&quot;: &quot;A String&quot;, # ID of the creative associated with the campaign. This is a required field.
149 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#campaignCreativeAssociation&quot;.
150 },
151 ],
152 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#campaignCreativeAssociationsListResponse&quot;.
153 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
154}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]155</div>
156
157<div class="method">
158 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
159 <pre>Retrieves the next page of results.
160
161Args:
162 previous_request: The request for the previous page. (required)
163 previous_response: The response from the request for the previous page. (required)
164
165Returns:
166 A request object that you can call &#x27;execute()&#x27; on to request the next
167 page. Returns None if there are no more items in the collection.
168 </pre>
169</div>
170
171</body></html>