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
|
<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.customers.html">customers</a> . <a href="searchads360_v0.customers.customColumns.html">customColumns</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 the requested custom column in full detail.</p>
<p class="toc_element">
<code><a href="#list">list(customerId, x__xgafv=None)</a></code></p>
<p class="firstline">Returns all the custom columns associated with the customer in full detail.</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 the requested custom column in full detail.
Args:
resourceName: string, Required. The resource name of the custom column to fetch. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A custom column. See Search Ads 360 custom column at https://support.google.com/sa360/answer/9633916
"description": "A String", # Output only. User-defined description of the custom column.
"id": "A String", # Output only. ID of the custom column.
"name": "A String", # Output only. User-defined name of the custom column.
"queryable": True or False, # Output only. True when the custom column is available to be used in the query of SearchAds360Service.Search and SearchAds360Service.SearchStream.
"referencedSystemColumns": [ # Output only. The list of the referenced system columns of this custom column. For example, A custom column "sum of impressions and clicks" has referenced system columns of {"metrics.clicks", "metrics.impressions"}.
"A String",
],
"referencesAttributes": True or False, # Output only. True when the custom column is referring to one or more attributes.
"referencesMetrics": True or False, # Output only. True when the custom column is referring to one or more metrics.
"renderType": "A String", # Output only. How the result value of the custom column should be interpreted.
"resourceName": "A String", # Immutable. The resource name of the custom column. Custom column resource names have the form: `customers/{customer_id}/customColumns/{custom_column_id}`
"valueType": "A String", # Output only. The type of the result value of the custom column.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customerId, x__xgafv=None)</code>
<pre>Returns all the custom columns associated with the customer in full detail.
Args:
customerId: string, Required. The ID of the customer to apply the CustomColumn list operation to. (required)
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 fetching all custom columns associated with a customer.
"customColumns": [ # The CustomColumns owned by the provided customer.
{ # A custom column. See Search Ads 360 custom column at https://support.google.com/sa360/answer/9633916
"description": "A String", # Output only. User-defined description of the custom column.
"id": "A String", # Output only. ID of the custom column.
"name": "A String", # Output only. User-defined name of the custom column.
"queryable": True or False, # Output only. True when the custom column is available to be used in the query of SearchAds360Service.Search and SearchAds360Service.SearchStream.
"referencedSystemColumns": [ # Output only. The list of the referenced system columns of this custom column. For example, A custom column "sum of impressions and clicks" has referenced system columns of {"metrics.clicks", "metrics.impressions"}.
"A String",
],
"referencesAttributes": True or False, # Output only. True when the custom column is referring to one or more attributes.
"referencesMetrics": True or False, # Output only. True when the custom column is referring to one or more metrics.
"renderType": "A String", # Output only. How the result value of the custom column should be interpreted.
"resourceName": "A String", # Immutable. The resource name of the custom column. Custom column resource names have the form: `customers/{customer_id}/customColumns/{custom_column_id}`
"valueType": "A String", # Output only. The type of the result value of the custom column.
},
],
}</pre>
</div>
</body></html>
|
