DCM/DFA Reporting And Trafficking API . projects

Instance Methods

close()

Close httplib2 connections.

get(profileId, id, x__xgafv=None)

Gets one project by ID.

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

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

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(profileId, id, x__xgafv=None)
Gets one project by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Project 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 Planning project.
    "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
    "clientName": "A String", # Name of the project client.
    "overview": "A String", # Overview of this project.
    "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
    "accountId": "A String", # Account ID of this project.
    "subaccountId": "A String", # Subaccount ID of this project.
    "audienceGender": "A String", # Audience gender of this project.
    "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
    "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
    "audienceAgeGroup": "A String", # Audience age group of this project.
    "startDate": "A String",
    "name": "A String", # Name of this project.
    "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
    "targetCpmActiveViewNanos": "A String", # vCPM from Active View that the advertiser is targeting.
    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
    },
    "clientBillingCode": "A String", # Client billing code of this project.
    "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
    "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
    "id": "A String", # ID of this project. This is a read-only, auto-generated field.
    "advertiserId": "A String", # Advertiser ID of this project.
    "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
    "endDate": "A String",
  }
list(profileId, sortField=None, searchString=None, sortOrder=None, pageToken=None, maxResults=None, advertiserIds=None, ids=None, x__xgafv=None)
Retrieves a list of projects, possibly filtered. This method supports paging .

Args:
  profileId: string, User profile ID associated with this request. (required)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  searchString: string, Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 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 "project" will match projects with name "my project", "project 2015", or simply "project".
  sortOrder: string, Order of sorted results.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  pageToken: string, Value of the nextPageToken from the previous result page.
  maxResults: integer, Maximum number of results to return.
  advertiserIds: string, Select only projects with these advertiser IDs. (repeated)
  ids: string, Select only projects with these IDs. (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Project List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse".
    "projects": [ # Project collection.
      { # Contains properties of a Planning project.
        "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
        "clientName": "A String", # Name of the project client.
        "overview": "A String", # Overview of this project.
        "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
        "accountId": "A String", # Account ID of this project.
        "subaccountId": "A String", # Subaccount ID of this project.
        "audienceGender": "A String", # Audience gender of this project.
        "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
        "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
        "audienceAgeGroup": "A String", # Audience age group of this project.
        "startDate": "A String",
        "name": "A String", # Name of this project.
        "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
        "targetCpmActiveViewNanos": "A String", # vCPM from Active View that the advertiser is targeting.
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "clientBillingCode": "A String", # Client billing code of this project.
        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
        "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
        "id": "A String", # ID of this project. This is a read-only, auto-generated field.
        "advertiserId": "A String", # Advertiser ID of this project.
        "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
        "endDate": "A String",
      },
    ],
  }
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.