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
|
<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="searchads360_v0.html">Search Ads 360 Reporting API</a> . <a href="searchads360_v0.searchAds360Fields.html">searchAds360Fields</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(resourceName, x__xgafv=None)</a></code></p>
<p class="firstline">Returns just the requested field. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()</p>
<p class="toc_element">
<code><a href="#search">search(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns all fields that match the search [query](/search-ads/reporting/concepts/field-service#use_a_query_to_get_field_details). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()</p>
<p class="toc_element">
<code><a href="#search_next">search_next()</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(resourceName, x__xgafv=None)</code>
<pre>Returns just the requested field. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
Args:
resourceName: string, Required. The resource name of the field to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A field or resource (artifact) used by SearchAds360Service.
"attributeResources": [ # Output only. The names of all resources that are selectable with the described artifact. Fields from these resources do not segment metrics when included in search queries. This field is only set for artifacts whose category is RESOURCE.
"A String",
],
"category": "A String", # Output only. The category of the artifact.
"dataType": "A String", # Output only. This field determines the operators that can be used with the artifact in WHERE clauses.
"enumValues": [ # Output only. Values the artifact can assume if it is a field of type ENUM. This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
"A String",
],
"filterable": True or False, # Output only. Whether the artifact can be used in a WHERE clause in search queries.
"isRepeated": True or False, # Output only. Whether the field artifact is repeated.
"metrics": [ # Output only. This field lists the names of all metrics that are selectable with the described artifact when it is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.
"A String",
],
"name": "A String", # Output only. The name of the artifact.
"resourceName": "A String", # Output only. The resource name of the artifact. Artifact resource names have the form: `SearchAds360Fields/{name}`
"segments": [ # Output only. This field lists the names of all artifacts, whether a segment or another resource, that segment metrics when included in search queries and when the described artifact is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.
"A String",
],
"selectable": True or False, # Output only. Whether the artifact can be used in a SELECT clause in search queries.
"selectableWith": [ # Output only. The names of all resources, segments, and metrics that are selectable with the described artifact.
"A String",
],
"sortable": True or False, # Output only. Whether the artifact can be used in a ORDER BY clause in search queries.
"typeUrl": "A String", # Output only. The URL of proto describing the artifact's data type.
}</pre>
</div>
<div class="method">
<code class="details" id="search">search(body=None, x__xgafv=None)</code>
<pre>Returns all fields that match the search [query](/search-ads/reporting/concepts/field-service#use_a_query_to_get_field_details). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
Args:
body: object, The request body.
The object takes the form of:
{ # Request message for SearchAds360FieldService.SearchSearchAds360Fields.
"pageSize": 42, # Number of elements to retrieve in a single page. When too large a page is requested, the server may decide to further limit the number of returned resources.
"pageToken": "A String", # Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from `next_page_token` in the previous response in order to request the next page of results.
"query": "A String", # Required. The query string.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for SearchAds360FieldService.SearchSearchAds360Fields.
"nextPageToken": "A String", # Pagination token used to retrieve the next page of results. Pass the content of this string as the `page_token` attribute of the next request. `next_page_token` is not returned for the last page.
"results": [ # The list of fields that matched the query.
{ # A field or resource (artifact) used by SearchAds360Service.
"attributeResources": [ # Output only. The names of all resources that are selectable with the described artifact. Fields from these resources do not segment metrics when included in search queries. This field is only set for artifacts whose category is RESOURCE.
"A String",
],
"category": "A String", # Output only. The category of the artifact.
"dataType": "A String", # Output only. This field determines the operators that can be used with the artifact in WHERE clauses.
"enumValues": [ # Output only. Values the artifact can assume if it is a field of type ENUM. This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
"A String",
],
"filterable": True or False, # Output only. Whether the artifact can be used in a WHERE clause in search queries.
"isRepeated": True or False, # Output only. Whether the field artifact is repeated.
"metrics": [ # Output only. This field lists the names of all metrics that are selectable with the described artifact when it is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.
"A String",
],
"name": "A String", # Output only. The name of the artifact.
"resourceName": "A String", # Output only. The resource name of the artifact. Artifact resource names have the form: `SearchAds360Fields/{name}`
"segments": [ # Output only. This field lists the names of all artifacts, whether a segment or another resource, that segment metrics when included in search queries and when the described artifact is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.
"A String",
],
"selectable": True or False, # Output only. Whether the artifact can be used in a SELECT clause in search queries.
"selectableWith": [ # Output only. The names of all resources, segments, and metrics that are selectable with the described artifact.
"A String",
],
"sortable": True or False, # Output only. Whether the artifact can be used in a ORDER BY clause in search queries.
"typeUrl": "A String", # Output only. The URL of proto describing the artifact's data type.
},
],
"totalResultsCount": "A String", # Total number of results that match the query ignoring the LIMIT clause.
}</pre>
</div>
<div class="method">
<code class="details" id="search_next">search_next()</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>
|
