Campaign Manager 360 API . advertiserGroups

close()

Close httplib2 connections.

delete(profileId, id, x__xgafv=None)

Deletes an existing advertiser group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser group ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

get(profileId, id, x__xgafv=None)

Gets one advertiser group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Advertiser 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:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
  "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
  "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
}

insert(profileId, body=None, x__xgafv=None)

Inserts a new advertiser group.

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

{ # Groups advertisers together so that reports can be generated for the entire group at once.
  "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
  "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
  "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
  "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
}

list(profileId, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)

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

Args:
  profileId: string, User profile ID associated with this request. (required)
  ids: string, Select only advertiser 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 objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".
  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:

    { # Advertiser Group List Response
  "advertiserGroups": [ # Advertiser group collection.
    { # Groups advertisers together so that reports can be generated for the entire group at once.
      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
      "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
    },
  ],
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse".
  "nextPageToken": "A String", # Pagination token to be used for the next list operation.
}

list_next()

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, x__xgafv=None)

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

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

{ # Groups advertisers together so that reports can be generated for the entire group at once.
  "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
  "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
  "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
  "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
}

update(profileId, body=None, x__xgafv=None)

Updates an existing advertiser group.

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

{ # Groups advertisers together so that reports can be generated for the entire group at once.
  "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
  "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Groups advertisers together so that reports can be generated for the entire group at once.
  "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
  "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
  "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
}