1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
<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_v3_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Gets one project by ID.</p>
<p class="toc_element">
<code><a href="#list">list(profileId, advertiserIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of projects, 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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(profileId, id, x__xgafv=None)</code>
<pre>Gets one project by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Project ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a Planning project.
"accountId": "A String", # Account ID of this project.
"advertiserId": "A String", # Advertiser ID of this project.
"audienceAgeGroup": "A String", # Audience age group of this project.
"audienceGender": "A String", # Audience gender of this project.
"budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
"clientBillingCode": "A String", # Client billing code of this project.
"clientName": "A String", # Name of the project client.
"endDate": "A String",
"id": "A String", # ID of this project. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Name of this project.
"overview": "A String", # Overview of this project.
"startDate": "A String",
"subaccountId": "A String", # Subaccount ID of this project.
"targetClicks": "A String", # Number of clicks that the advertiser is targeting.
"targetConversions": "A String", # Number of conversions that the advertiser is targeting.
"targetCpaNanos": "A String", # CPA that the advertiser is targeting.
"targetCpcNanos": "A String", # CPC that the advertiser is targeting.
"targetCpmActiveViewNanos": "A String", # vCPM from Active View that the advertiser is targeting.
"targetCpmNanos": "A String", # CPM that the advertiser is targeting.
"targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, advertiserIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</code>
<pre>Retrieves a list of projects, possibly filtered. This method supports paging .
Args:
profileId: string, User profile ID associated with this request. (required)
advertiserIds: string, Select only projects with these advertiser IDs. (repeated)
ids: string, Select only projects with these IDs. (repeated)
maxResults: integer, Maximum number of results to return.
pageToken: string, Value of the nextPageToken from the previous result page.
searchString: string, Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 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 "project" will match projects with name "my project", "project 2015", or simply "project".
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Project List Response
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse".
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"projects": [ # Project collection.
{ # Contains properties of a Planning project.
"accountId": "A String", # Account ID of this project.
"advertiserId": "A String", # Advertiser ID of this project.
"audienceAgeGroup": "A String", # Audience age group of this project.
"audienceGender": "A String", # Audience gender of this project.
"budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
"clientBillingCode": "A String", # Client billing code of this project.
"clientName": "A String", # Name of the project client.
"endDate": "A String",
"id": "A String", # ID of this project. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Name of this project.
"overview": "A String", # Overview of this project.
"startDate": "A String",
"subaccountId": "A String", # Subaccount ID of this project.
"targetClicks": "A String", # Number of clicks that the advertiser is targeting.
"targetConversions": "A String", # Number of conversions that the advertiser is targeting.
"targetCpaNanos": "A String", # CPA that the advertiser is targeting.
"targetCpcNanos": "A String", # CPC that the advertiser is targeting.
"targetCpmActiveViewNanos": "A String", # vCPM from Active View that the advertiser is targeting.
"targetCpmNanos": "A String", # CPM that the advertiser is targeting.
"targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
},
],
}</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>
</body></html>
|
