<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_v4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v4.creativeGroups.html">creativeGroups</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 creative group by ID.</p>
<p class="toc_element">
  <code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new creative group.</p>
<p class="toc_element">
  <code><a href="#list">list(profileId, advertiserIds=None, groupNumber=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 creative groups, possibly filtered. This method supports paging.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing creative group. This method supports patch semantics.</p>
<p class="toc_element">
  <code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing creative group.</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 creative group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Creative group 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 creative group.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this creative group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this creative group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;groupNumber&quot;: 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
  &quot;id&quot;: &quot;A String&quot;, # ID of this creative group. This is a read-only, auto-generated field.
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#creativeGroup&quot;.
  &quot;name&quot;: &quot;A String&quot;, # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this creative group. This is a read-only field that can be left blank.
}</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
  <pre>Inserts a new creative group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of a creative group.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this creative group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this creative group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;groupNumber&quot;: 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
  &quot;id&quot;: &quot;A String&quot;, # ID of this creative group. This is a read-only, auto-generated field.
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#creativeGroup&quot;.
  &quot;name&quot;: &quot;A String&quot;, # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this creative group. This is a read-only field that can be left blank.
}

  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 creative group.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this creative group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this creative group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;groupNumber&quot;: 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
  &quot;id&quot;: &quot;A String&quot;, # ID of this creative group. This is a read-only, auto-generated field.
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#creativeGroup&quot;.
  &quot;name&quot;: &quot;A String&quot;, # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this creative group. This is a read-only field that can be left blank.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(profileId, advertiserIds=None, groupNumber=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</code>
  <pre>Retrieves a list of creative groups, possibly filtered. This method supports paging.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserIds: string, Select only creative groups that belong to these advertisers. (repeated)
  groupNumber: integer, Select only creative groups that belong to this subgroup.
  ids: string, Select only creative groups 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 creative groups by name or ID. Wildcards (*) are allowed. For example, &quot;creativegroup*2015&quot; will return creative groups with names like &quot;creativegroup June 2015&quot;, &quot;creativegroup April 2015&quot;, or simply &quot;creativegroup 2015&quot;. Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of &quot;creativegroup&quot; will match creative groups with the name &quot;my creativegroup&quot;, &quot;creativegroup 2015&quot;, or simply &quot;creativegroup&quot;.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  sortOrder: string, Order of sorted results.
    Allowed values
      ASCENDING - Ascending order.
      DESCENDING - Descending order.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Creative Group List Response
  &quot;creativeGroups&quot;: [ # Creative group collection.
    { # Contains properties of a creative group.
      &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this creative group. This is a read-only field that can be left blank.
      &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this creative group. This is a required field on insertion.
      &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
        &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
        &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
        &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
        &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
        &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
      },
      &quot;groupNumber&quot;: 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
      &quot;id&quot;: &quot;A String&quot;, # ID of this creative group. This is a read-only, auto-generated field.
      &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#creativeGroup&quot;.
      &quot;name&quot;: &quot;A String&quot;, # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
      &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    },
  ],
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#creativeGroupsListResponse&quot;.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_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 &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
  <pre>Updates an existing creative group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Required. Creative Group ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of a creative group.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this creative group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this creative group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;groupNumber&quot;: 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
  &quot;id&quot;: &quot;A String&quot;, # ID of this creative group. This is a read-only, auto-generated field.
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#creativeGroup&quot;.
  &quot;name&quot;: &quot;A String&quot;, # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this creative group. This is a read-only field that can be left blank.
}

  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 creative group.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this creative group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this creative group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;groupNumber&quot;: 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
  &quot;id&quot;: &quot;A String&quot;, # ID of this creative group. This is a read-only, auto-generated field.
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#creativeGroup&quot;.
  &quot;name&quot;: &quot;A String&quot;, # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this creative group. This is a read-only field that can be left blank.
}</pre>
</div>

<div class="method">
    <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
  <pre>Updates an existing creative group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of a creative group.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this creative group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this creative group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;groupNumber&quot;: 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
  &quot;id&quot;: &quot;A String&quot;, # ID of this creative group. This is a read-only, auto-generated field.
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#creativeGroup&quot;.
  &quot;name&quot;: &quot;A String&quot;, # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this creative group. This is a read-only field that can be left blank.
}

  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 creative group.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this creative group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this creative group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;groupNumber&quot;: 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
  &quot;id&quot;: &quot;A String&quot;, # ID of this creative group. This is a read-only, auto-generated field.
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#creativeGroup&quot;.
  &quot;name&quot;: &quot;A String&quot;, # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this creative group. This is a read-only field that can be left blank.
}</pre>
</div>

</body></html>