# DCM/DFA Reporting And Trafficking API . creativeGroups

## Instance Methods

Gets one creative group by ID.

Inserts a new creative group.

Retrieves a list of creative groups, possibly filtered. This method supports paging.

Retrieves the next page of results.

Updates an existing creative group. This method supports patch semantics.

Updates an existing creative group.

### Method Details

`get(profileId, id)`

    Gets one creative group by ID.

    Args:
      profileId: string, User profile ID associated with this request. (required)
      id: string, Creative group ID. (required)

    Returns:
      An object of the form:

        { # Contains properties of a creative group.
        "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
        "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
        "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
          "dimensionName": "A String", # The name of the dimension.
          "etag": "A String", # The eTag of this response for caching purposes.
          "id": "A String", # The ID associated with the value if available.
          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
          "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
          "value": "A String", # The value of the dimension.
        },
        "groupNumber": 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.
        "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
        "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
        "name": "A String", # 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.
        "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      }

`insert(profileId, body=None)`

    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.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "dimensionName": "A String", # The name of the dimension.
        "etag": "A String", # The eTag of this response for caching purposes.
        "id": "A String", # The ID associated with the value if available.
        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
        "value": "A String", # The value of the dimension.
      },
      "groupNumber": 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.
      "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "name": "A String", # 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.
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    }

    Returns:
      An object of the form:

        { # Contains properties of a creative group.
        "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
        "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
        "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
          "dimensionName": "A String", # The name of the dimension.
          "etag": "A String", # The eTag of this response for caching purposes.
          "id": "A String", # The ID associated with the value if available.
          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
          "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
          "value": "A String", # The value of the dimension.
        },
        "groupNumber": 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.
        "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
        "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
        "name": "A String", # 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.
        "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      }

`list(profileId, advertiserIds=None, groupNumber=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None)`

    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, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". 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 "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".
      sortField: string, Field by which to sort the list.
        Allowed values
          ID -
          NAME -
      sortOrder: string, Order of sorted results.
        Allowed values
          ASCENDING -
          DESCENDING -

    Returns:
      An object of the form:

        { # Creative Group List Response
        "creativeGroups": [ # Creative group collection.
          { # Contains properties of a creative group.
            "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
            "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
            "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
              "dimensionName": "A String", # The name of the dimension.
              "etag": "A String", # The eTag of this response for caching purposes.
              "id": "A String", # The ID associated with the value if available.
              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
              "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
              "value": "A String", # The value of the dimension.
            },
            "groupNumber": 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.
            "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
            "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
            "name": "A String", # 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.
            "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
          },
        ],
        "kind": "dfareporting#creativeGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse".
        "nextPageToken": "A String", # Pagination token to be used for the next list operation.
      }

`list_next(previous_request, previous_response)`

    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.

`patch(profileId, id, body=None)`

    Updates an existing creative group. This method supports patch semantics.

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

    { # Contains properties of a creative group.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "dimensionName": "A String", # The name of the dimension.
        "etag": "A String", # The eTag of this response for caching purposes.
        "id": "A String", # The ID associated with the value if available.
        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
        "value": "A String", # The value of the dimension.
      },
      "groupNumber": 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.
      "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "name": "A String", # 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.
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    }

    Returns:
      An object of the form:

        { # Contains properties of a creative group.
        "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
        "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
        "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
          "dimensionName": "A String", # The name of the dimension.
          "etag": "A String", # The eTag of this response for caching purposes.
          "id": "A String", # The ID associated with the value if available.
          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
          "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
          "value": "A String", # The value of the dimension.
        },
        "groupNumber": 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.
        "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
        "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
        "name": "A String", # 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.
        "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      }

`update(profileId, body=None)`

    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.
      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "dimensionName": "A String", # The name of the dimension.
        "etag": "A String", # The eTag of this response for caching purposes.
        "id": "A String", # The ID associated with the value if available.
        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
        "value": "A String", # The value of the dimension.
      },
      "groupNumber": 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.
      "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
      "name": "A String", # 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.
      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
    }

    Returns:
      An object of the form:

        { # Contains properties of a creative group.
        "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
        "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
        "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
          "dimensionName": "A String", # The name of the dimension.
          "etag": "A String", # The eTag of this response for caching purposes.
          "id": "A String", # The ID associated with the value if available.
          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
          "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
          "value": "A String", # The value of the dimension.
        },
        "groupNumber": 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.
        "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
        "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
        "name": "A String", # 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.
        "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
      }