get(profileId, id, x__xgafv=None)

Gets one subaccount by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Subaccount 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 Campaign Manager subaccount.
  "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
    "A String",
  ],
  "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
  "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
}

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

Inserts a new subaccount.

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 Campaign Manager subaccount.
  "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
    "A String",
  ],
  "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
  "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts 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:

    { # Contains properties of a Campaign Manager subaccount.
  "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
    "A String",
  ],
  "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
  "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
}

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

Gets a list of subaccounts, possibly filtered. This method supports paging.

Args:
  profileId: string, User profile ID associated with this request. (required)
  ids: string, Select only subaccounts 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, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 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 "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount" .
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  sortOrder: string, Order of sorted results.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Subaccount List Response
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse".
  "nextPageToken": "A String", # Pagination token to be used for the next list operation.
  "subaccounts": [ # Subaccount collection.
    { # Contains properties of a Campaign Manager subaccount.
      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
        "A String",
      ],
      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
      "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
    },
  ],
}

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

Updates an existing subaccount. This method supports patch semantics.

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

{ # Contains properties of a Campaign Manager subaccount.
  "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
    "A String",
  ],
  "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
  "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts 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:

    { # Contains properties of a Campaign Manager subaccount.
  "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
    "A String",
  ],
  "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
  "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
}

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

Updates an existing subaccount.

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 Campaign Manager subaccount.
  "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
    "A String",
  ],
  "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
  "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts 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:

    { # Contains properties of a Campaign Manager subaccount.
  "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
  "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
    "A String",
  ],
  "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
  "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
}

Campaign Manager 360 API . subaccounts

Instance Methods

Method Details