docs/dyn/searchads360_v0.customers.customColumns.html

<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
  &quot;description&quot;: &quot;A String&quot;, # Output only. User-defined description of the custom column.
  &quot;id&quot;: &quot;A String&quot;, # Output only. ID of the custom column.
  &quot;name&quot;: &quot;A String&quot;, # Output only. User-defined name of the custom column.
  &quot;queryable&quot;: True or False, # Output only. True when the custom column is available to be used in the query of SearchAds360Service.Search and SearchAds360Service.SearchStream.
  &quot;referencedSystemColumns&quot;: [ # Output only. The list of the referenced system columns of this custom column. For example, A custom column &quot;sum of impressions and clicks&quot; has referenced system columns of {&quot;metrics.clicks&quot;, &quot;metrics.impressions&quot;}.
    &quot;A String&quot;,
  ],
  &quot;referencesAttributes&quot;: True or False, # Output only. True when the custom column is referring to one or more attributes.
  &quot;referencesMetrics&quot;: True or False, # Output only. True when the custom column is referring to one or more metrics.
  &quot;resourceName&quot;: &quot;A String&quot;, # Immutable. The resource name of the custom column. Custom column resource names have the form: `customers/{customer_id}/customColumns/{custom_column_id}`
  &quot;valueType&quot;: &quot;A String&quot;, # 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.
  &quot;customColumns&quot;: [ # The CustomColumns owned by the provided customer.
    { # A custom column. See Search Ads 360 custom column at https://support.google.com/sa360/answer/9633916
      &quot;description&quot;: &quot;A String&quot;, # Output only. User-defined description of the custom column.
      &quot;id&quot;: &quot;A String&quot;, # Output only. ID of the custom column.
      &quot;name&quot;: &quot;A String&quot;, # Output only. User-defined name of the custom column.
      &quot;queryable&quot;: True or False, # Output only. True when the custom column is available to be used in the query of SearchAds360Service.Search and SearchAds360Service.SearchStream.
      &quot;referencedSystemColumns&quot;: [ # Output only. The list of the referenced system columns of this custom column. For example, A custom column &quot;sum of impressions and clicks&quot; has referenced system columns of {&quot;metrics.clicks&quot;, &quot;metrics.impressions&quot;}.
        &quot;A String&quot;,
      ],
      &quot;referencesAttributes&quot;: True or False, # Output only. True when the custom column is referring to one or more attributes.
      &quot;referencesMetrics&quot;: True or False, # Output only. True when the custom column is referring to one or more metrics.
      &quot;resourceName&quot;: &quot;A String&quot;, # Immutable. The resource name of the custom column. Custom column resource names have the form: `customers/{customer_id}/customColumns/{custom_column_id}`
      &quot;valueType&quot;: &quot;A String&quot;, # Output only. The type of the result value of the custom column.
    },
  ],
}</pre>
</div>

</body></html>